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

azure.appservice.WindowsWebApp

Manages a Windows Web App.

Example Usage

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

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

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

    var exampleWindowsWebApp = new Azure.AppService.WindowsWebApp("exampleWindowsWebApp", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleServicePlan.Location,
        ServicePlanId = exampleServicePlan.Id,
        SiteConfig = null,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleServicePlan, err := appservice.NewServicePlan(ctx, "exampleServicePlan", &appservice.ServicePlanArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
			SkuName:           pulumi.String("P1v2"),
			OsType:            pulumi.String("Windows"),
		})
		if err != nil {
			return err
		}
		_, err = appservice.NewWindowsWebApp(ctx, "exampleWindowsWebApp", &appservice.WindowsWebAppArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleServicePlan.Location,
			ServicePlanId:     exampleServicePlan.ID(),
			SiteConfig:        nil,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.appservice.ServicePlan;
import com.pulumi.azure.appservice.ServicePlanArgs;
import com.pulumi.azure.appservice.WindowsWebApp;
import com.pulumi.azure.appservice.WindowsWebAppArgs;
import com.pulumi.azure.appservice.inputs.WindowsWebAppSiteConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleServicePlan = new ServicePlan("exampleServicePlan", ServicePlanArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .skuName("P1v2")
            .osType("Windows")
            .build());

        var exampleWindowsWebApp = new WindowsWebApp("exampleWindowsWebApp", WindowsWebAppArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleServicePlan.location())
            .servicePlanId(exampleServicePlan.id())
            .siteConfig()
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service_plan = azure.appservice.ServicePlan("exampleServicePlan",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku_name="P1v2",
    os_type="Windows")
example_windows_web_app = azure.appservice.WindowsWebApp("exampleWindowsWebApp",
    resource_group_name=example_resource_group.name,
    location=example_service_plan.location,
    service_plan_id=example_service_plan.id,
    site_config=azure.appservice.WindowsWebAppSiteConfigArgs())

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleServicePlan = new azure.appservice.ServicePlan("exampleServicePlan", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    skuName: "P1v2",
    osType: "Windows",
});
const exampleWindowsWebApp = new azure.appservice.WindowsWebApp("exampleWindowsWebApp", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleServicePlan.location,
    servicePlanId: exampleServicePlan.id,
    siteConfig: {},
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleServicePlan:
    type: azure:appservice:ServicePlan
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      skuName: P1v2
      osType: Windows
  exampleWindowsWebApp:
    type: azure:appservice:WindowsWebApp
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleServicePlan.location}
      servicePlanId: ${exampleServicePlan.id}
      siteConfig: {}

Create WindowsWebApp Resource

new WindowsWebApp(name: string, args: WindowsWebAppArgs, opts?: CustomResourceOptions);
@overload
def WindowsWebApp(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  app_settings: Optional[Mapping[str, str]] = None,
                  auth_settings: Optional[WindowsWebAppAuthSettingsArgs] = None,
                  auth_settings_v2: Optional[WindowsWebAppAuthSettingsV2Args] = None,
                  backup: Optional[WindowsWebAppBackupArgs] = None,
                  client_affinity_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[WindowsWebAppConnectionStringArgs]] = None,
                  enabled: Optional[bool] = None,
                  https_only: Optional[bool] = None,
                  identity: Optional[WindowsWebAppIdentityArgs] = None,
                  key_vault_reference_identity_id: Optional[str] = None,
                  location: Optional[str] = None,
                  logs: Optional[WindowsWebAppLogsArgs] = None,
                  name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  service_plan_id: Optional[str] = None,
                  site_config: Optional[WindowsWebAppSiteConfigArgs] = None,
                  sticky_settings: Optional[WindowsWebAppStickySettingsArgs] = None,
                  storage_accounts: Optional[Sequence[WindowsWebAppStorageAccountArgs]] = None,
                  tags: Optional[Mapping[str, str]] = None,
                  virtual_network_subnet_id: Optional[str] = None,
                  zip_deploy_file: Optional[str] = None)
@overload
def WindowsWebApp(resource_name: str,
                  args: WindowsWebAppArgs,
                  opts: Optional[ResourceOptions] = None)
func NewWindowsWebApp(ctx *Context, name string, args WindowsWebAppArgs, opts ...ResourceOption) (*WindowsWebApp, error)
public WindowsWebApp(string name, WindowsWebAppArgs args, CustomResourceOptions? opts = null)
public WindowsWebApp(String name, WindowsWebAppArgs args)
public WindowsWebApp(String name, WindowsWebAppArgs args, CustomResourceOptions options)

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

WindowsWebApp Resource Properties

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

Inputs

The WindowsWebApp resource accepts the following input properties:

ResourceGroupName string

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

ServicePlanId string

The ID of the Service Plan that this Windows App Service will be created in.

SiteConfig WindowsWebAppSiteConfigArgs

A site_config block as defined below.

AppSettings Dictionary<string, string>

A map of key-value pairs of App Settings.

AuthSettings WindowsWebAppAuthSettingsArgs

An auth_settings block as defined below.

AuthSettingsV2 WindowsWebAppAuthSettingsV2Args

An auth_settings_v2 block as defined below.

Backup WindowsWebAppBackupArgs

A backup block as defined below.

ClientAffinityEnabled bool

Should Client Affinity be enabled?

ClientCertificateEnabled bool

Should Client Certificates be enabled?

ClientCertificateExclusionPaths string

Paths to exclude when using client certificates, separated by ;

ClientCertificateMode string

The Client Certificate mode. Possible values are Required, Optional, and OptionalInteractiveUser. This property has no effect when client_cert_enabled is false

ConnectionStrings List<WindowsWebAppConnectionStringArgs>

One or more connection_string blocks as defined below.

Enabled bool

Should the Windows Web App be enabled? Defaults to true.

HttpsOnly bool

Should the Windows Web App require HTTPS connections.

Identity WindowsWebAppIdentityArgs

An identity block as defined below.

KeyVaultReferenceIdentityId string

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

Location string

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

Logs WindowsWebAppLogsArgs

A logs block as defined below.

Name string

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

StickySettings WindowsWebAppStickySettingsArgs

A sticky_settings block as defined below.

StorageAccounts List<WindowsWebAppStorageAccountArgs>

One or more storage_account blocks as defined below.

Tags Dictionary<string, string>

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

VirtualNetworkSubnetId string

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

ZipDeployFile string

The local path and filename of the Zip packaged application to deploy to this Windows Web App.

ResourceGroupName string

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

ServicePlanId string

The ID of the Service Plan that this Windows App Service will be created in.

SiteConfig WindowsWebAppSiteConfigArgs

A site_config block as defined below.

AppSettings map[string]string

A map of key-value pairs of App Settings.

AuthSettings WindowsWebAppAuthSettingsArgs

An auth_settings block as defined below.

AuthSettingsV2 WindowsWebAppAuthSettingsV2Args

An auth_settings_v2 block as defined below.

Backup WindowsWebAppBackupArgs

A backup block as defined below.

ClientAffinityEnabled bool

Should Client Affinity be enabled?

ClientCertificateEnabled bool

Should Client Certificates be enabled?

ClientCertificateExclusionPaths string

Paths to exclude when using client certificates, separated by ;

ClientCertificateMode string

The Client Certificate mode. Possible values are Required, Optional, and OptionalInteractiveUser. This property has no effect when client_cert_enabled is false

ConnectionStrings []WindowsWebAppConnectionStringArgs

One or more connection_string blocks as defined below.

Enabled bool

Should the Windows Web App be enabled? Defaults to true.

HttpsOnly bool

Should the Windows Web App require HTTPS connections.

Identity WindowsWebAppIdentityArgs

An identity block as defined below.

KeyVaultReferenceIdentityId string

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

Location string

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

Logs WindowsWebAppLogsArgs

A logs block as defined below.

Name string

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

StickySettings WindowsWebAppStickySettingsArgs

A sticky_settings block as defined below.

StorageAccounts []WindowsWebAppStorageAccountArgs

One or more storage_account blocks as defined below.

Tags map[string]string

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

VirtualNetworkSubnetId string

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

ZipDeployFile string

The local path and filename of the Zip packaged application to deploy to this Windows Web App.

resourceGroupName String

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

servicePlanId String

The ID of the Service Plan that this Windows App Service will be created in.

siteConfig WindowsWebAppSiteConfigArgs

A site_config block as defined below.

appSettings Map<String,String>

A map of key-value pairs of App Settings.

authSettings WindowsWebAppAuthSettingsArgs

An auth_settings block as defined below.

authSettingsV2 WindowsWebAppAuthSettingsV2Args

An auth_settings_v2 block as defined below.

backup WindowsWebAppBackupArgs

A backup block as defined below.

clientAffinityEnabled Boolean

Should Client Affinity be enabled?

clientCertificateEnabled Boolean

Should Client Certificates be enabled?

clientCertificateExclusionPaths String

Paths to exclude when using client certificates, separated by ;

clientCertificateMode String

The Client Certificate mode. Possible values are Required, Optional, and OptionalInteractiveUser. This property has no effect when client_cert_enabled is false

connectionStrings List<WindowsWebAppConnectionStringArgs>

One or more connection_string blocks as defined below.

enabled Boolean

Should the Windows Web App be enabled? Defaults to true.

httpsOnly Boolean

Should the Windows Web App require HTTPS connections.

identity WindowsWebAppIdentityArgs

An identity block as defined below.

keyVaultReferenceIdentityId String

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

location String

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

logs WindowsWebAppLogsArgs

A logs block as defined below.

name String

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

stickySettings WindowsWebAppStickySettingsArgs

A sticky_settings block as defined below.

storageAccounts List<WindowsWebAppStorageAccountArgs>

One or more storage_account blocks as defined below.

tags Map<String,String>

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

virtualNetworkSubnetId String

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

zipDeployFile String

The local path and filename of the Zip packaged application to deploy to this Windows Web App.

resourceGroupName string

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

servicePlanId string

The ID of the Service Plan that this Windows App Service will be created in.

siteConfig WindowsWebAppSiteConfigArgs

A site_config block as defined below.

appSettings {[key: string]: string}

A map of key-value pairs of App Settings.

authSettings WindowsWebAppAuthSettingsArgs

An auth_settings block as defined below.

authSettingsV2 WindowsWebAppAuthSettingsV2Args

An auth_settings_v2 block as defined below.

backup WindowsWebAppBackupArgs

A backup block as defined below.

clientAffinityEnabled boolean

Should Client Affinity be enabled?

clientCertificateEnabled boolean

Should Client Certificates be enabled?

clientCertificateExclusionPaths string

Paths to exclude when using client certificates, separated by ;

clientCertificateMode string

The Client Certificate mode. Possible values are Required, Optional, and OptionalInteractiveUser. This property has no effect when client_cert_enabled is false

connectionStrings WindowsWebAppConnectionStringArgs[]

One or more connection_string blocks as defined below.

enabled boolean

Should the Windows Web App be enabled? Defaults to true.

httpsOnly boolean

Should the Windows Web App require HTTPS connections.

identity WindowsWebAppIdentityArgs

An identity block as defined below.

keyVaultReferenceIdentityId string

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

location string

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

logs WindowsWebAppLogsArgs

A logs block as defined below.

name string

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

stickySettings WindowsWebAppStickySettingsArgs

A sticky_settings block as defined below.

storageAccounts WindowsWebAppStorageAccountArgs[]

One or more storage_account blocks as defined below.

tags {[key: string]: string}

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

virtualNetworkSubnetId string

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

zipDeployFile string

The local path and filename of the Zip packaged application to deploy to this Windows Web App.

resource_group_name str

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

service_plan_id str

The ID of the Service Plan that this Windows App Service will be created in.

site_config WindowsWebAppSiteConfigArgs

A site_config block as defined below.

app_settings Mapping[str, str]

A map of key-value pairs of App Settings.

auth_settings WindowsWebAppAuthSettingsArgs

An auth_settings block as defined below.

auth_settings_v2 WindowsWebAppAuthSettingsV2Args

An auth_settings_v2 block as defined below.

backup WindowsWebAppBackupArgs

A backup block as defined below.

client_affinity_enabled bool

Should Client Affinity be enabled?

client_certificate_enabled bool

Should Client Certificates be enabled?

client_certificate_exclusion_paths str

Paths to exclude when using client certificates, separated by ;

client_certificate_mode str

The Client Certificate mode. Possible values are Required, Optional, and OptionalInteractiveUser. This property has no effect when client_cert_enabled is false

connection_strings Sequence[WindowsWebAppConnectionStringArgs]

One or more connection_string blocks as defined below.

enabled bool

Should the Windows Web App be enabled? Defaults to true.

https_only bool

Should the Windows Web App require HTTPS connections.

identity WindowsWebAppIdentityArgs

An identity block as defined below.

key_vault_reference_identity_id str

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

location str

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

logs WindowsWebAppLogsArgs

A logs block as defined below.

name str

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

sticky_settings WindowsWebAppStickySettingsArgs

A sticky_settings block as defined below.

storage_accounts Sequence[WindowsWebAppStorageAccountArgs]

One or more storage_account blocks as defined below.

tags Mapping[str, str]

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

virtual_network_subnet_id str

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

zip_deploy_file str

The local path and filename of the Zip packaged application to deploy to this Windows Web App.

resourceGroupName String

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

servicePlanId String

The ID of the Service Plan that this Windows App Service will be created in.

siteConfig Property Map

A site_config block as defined below.

appSettings Map<String>

A map of key-value pairs of App Settings.

authSettings Property Map

An auth_settings block as defined below.

authSettingsV2 Property Map

An auth_settings_v2 block as defined below.

backup Property Map

A backup block as defined below.

clientAffinityEnabled Boolean

Should Client Affinity be enabled?

clientCertificateEnabled Boolean

Should Client Certificates be enabled?

clientCertificateExclusionPaths String

Paths to exclude when using client certificates, separated by ;

clientCertificateMode String

The Client Certificate mode. Possible values are Required, Optional, and OptionalInteractiveUser. This property has no effect when client_cert_enabled is false

connectionStrings List<Property Map>

One or more connection_string blocks as defined below.

enabled Boolean

Should the Windows Web App be enabled? Defaults to true.

httpsOnly Boolean

Should the Windows Web App require HTTPS connections.

identity Property Map

An identity block as defined below.

keyVaultReferenceIdentityId String

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

location String

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

logs Property Map

A logs block as defined below.

name String

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

stickySettings Property Map

A sticky_settings block as defined below.

storageAccounts List<Property Map>

One or more storage_account blocks as defined below.

tags Map<String>

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

virtualNetworkSubnetId String

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

zipDeployFile String

The local path and filename of the Zip packaged application to deploy to this Windows Web App.

Outputs

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

CustomDomainVerificationId string

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

DefaultHostname string

The default hostname of the Windows Web App.

Id string

The provider-assigned unique ID for this managed resource.

Kind string

The Kind value for this Windows Web App.

OutboundIpAddressLists List<string>

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12"]

OutboundIpAddresses string

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

PossibleOutboundIpAddressLists List<string>

A possible_outbound_ip_address_list block as defined below.

PossibleOutboundIpAddresses string

A comma separated list of outbound IP addresses - such as 52.23.25.3,52.143.43.12,52.143.43.17 - not all of which are necessarily in use. Superset of outbound_ip_addresses.

SiteCredentials List<WindowsWebAppSiteCredential>

A site_credential block as defined below.

CustomDomainVerificationId string

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

DefaultHostname string

The default hostname of the Windows Web App.

Id string

The provider-assigned unique ID for this managed resource.

Kind string

The Kind value for this Windows Web App.

OutboundIpAddressLists []string

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12"]

OutboundIpAddresses string

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

PossibleOutboundIpAddressLists []string

A possible_outbound_ip_address_list block as defined below.

PossibleOutboundIpAddresses string

A comma separated list of outbound IP addresses - such as 52.23.25.3,52.143.43.12,52.143.43.17 - not all of which are necessarily in use. Superset of outbound_ip_addresses.

SiteCredentials []WindowsWebAppSiteCredential

A site_credential block as defined below.

customDomainVerificationId String

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

defaultHostname String

The default hostname of the Windows Web App.

id String

The provider-assigned unique ID for this managed resource.

kind String

The Kind value for this Windows Web App.

outboundIpAddressLists List<String>

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12"]

outboundIpAddresses String

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

possibleOutboundIpAddressLists List<String>

A possible_outbound_ip_address_list block as defined below.

possibleOutboundIpAddresses String

A comma separated list of outbound IP addresses - such as 52.23.25.3,52.143.43.12,52.143.43.17 - not all of which are necessarily in use. Superset of outbound_ip_addresses.

siteCredentials List<WindowsWebAppSiteCredential>

A site_credential block as defined below.

customDomainVerificationId string

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

defaultHostname string

The default hostname of the Windows Web App.

id string

The provider-assigned unique ID for this managed resource.

kind string

The Kind value for this Windows Web App.

outboundIpAddressLists string[]

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12"]

outboundIpAddresses string

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

possibleOutboundIpAddressLists string[]

A possible_outbound_ip_address_list block as defined below.

possibleOutboundIpAddresses string

A comma separated list of outbound IP addresses - such as 52.23.25.3,52.143.43.12,52.143.43.17 - not all of which are necessarily in use. Superset of outbound_ip_addresses.

siteCredentials WindowsWebAppSiteCredential[]

A site_credential block as defined below.

custom_domain_verification_id str

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

default_hostname str

The default hostname of the Windows Web App.

id str

The provider-assigned unique ID for this managed resource.

kind str

The Kind value for this Windows Web App.

outbound_ip_address_lists Sequence[str]

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12"]

outbound_ip_addresses str

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

possible_outbound_ip_address_lists Sequence[str]

A possible_outbound_ip_address_list block as defined below.

possible_outbound_ip_addresses str

A comma separated list of outbound IP addresses - such as 52.23.25.3,52.143.43.12,52.143.43.17 - not all of which are necessarily in use. Superset of outbound_ip_addresses.

site_credentials Sequence[WindowsWebAppSiteCredential]

A site_credential block as defined below.

customDomainVerificationId String

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

defaultHostname String

The default hostname of the Windows Web App.

id String

The provider-assigned unique ID for this managed resource.

kind String

The Kind value for this Windows Web App.

outboundIpAddressLists List<String>

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12"]

outboundIpAddresses String

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

possibleOutboundIpAddressLists List<String>

A possible_outbound_ip_address_list block as defined below.

possibleOutboundIpAddresses String

A comma separated list of outbound IP addresses - such as 52.23.25.3,52.143.43.12,52.143.43.17 - not all of which are necessarily in use. Superset of outbound_ip_addresses.

siteCredentials List<Property Map>

A site_credential block as defined below.

Look up Existing WindowsWebApp Resource

Get an existing WindowsWebApp 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?: WindowsWebAppState, opts?: CustomResourceOptions): WindowsWebApp
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_settings: Optional[Mapping[str, str]] = None,
        auth_settings: Optional[WindowsWebAppAuthSettingsArgs] = None,
        auth_settings_v2: Optional[WindowsWebAppAuthSettingsV2Args] = None,
        backup: Optional[WindowsWebAppBackupArgs] = None,
        client_affinity_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[WindowsWebAppConnectionStringArgs]] = None,
        custom_domain_verification_id: Optional[str] = None,
        default_hostname: Optional[str] = None,
        enabled: Optional[bool] = None,
        https_only: Optional[bool] = None,
        identity: Optional[WindowsWebAppIdentityArgs] = None,
        key_vault_reference_identity_id: Optional[str] = None,
        kind: Optional[str] = None,
        location: Optional[str] = None,
        logs: Optional[WindowsWebAppLogsArgs] = None,
        name: Optional[str] = None,
        outbound_ip_address_lists: Optional[Sequence[str]] = None,
        outbound_ip_addresses: Optional[str] = None,
        possible_outbound_ip_address_lists: Optional[Sequence[str]] = None,
        possible_outbound_ip_addresses: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        service_plan_id: Optional[str] = None,
        site_config: Optional[WindowsWebAppSiteConfigArgs] = None,
        site_credentials: Optional[Sequence[WindowsWebAppSiteCredentialArgs]] = None,
        sticky_settings: Optional[WindowsWebAppStickySettingsArgs] = None,
        storage_accounts: Optional[Sequence[WindowsWebAppStorageAccountArgs]] = None,
        tags: Optional[Mapping[str, str]] = None,
        virtual_network_subnet_id: Optional[str] = None,
        zip_deploy_file: Optional[str] = None) -> WindowsWebApp
func GetWindowsWebApp(ctx *Context, name string, id IDInput, state *WindowsWebAppState, opts ...ResourceOption) (*WindowsWebApp, error)
public static WindowsWebApp Get(string name, Input<string> id, WindowsWebAppState? state, CustomResourceOptions? opts = null)
public static WindowsWebApp get(String name, Output<String> id, WindowsWebAppState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AppSettings Dictionary<string, string>

A map of key-value pairs of App Settings.

AuthSettings WindowsWebAppAuthSettingsArgs

An auth_settings block as defined below.

AuthSettingsV2 WindowsWebAppAuthSettingsV2Args

An auth_settings_v2 block as defined below.

Backup WindowsWebAppBackupArgs

A backup block as defined below.

ClientAffinityEnabled bool

Should Client Affinity be enabled?

ClientCertificateEnabled bool

Should Client Certificates be enabled?

ClientCertificateExclusionPaths string

Paths to exclude when using client certificates, separated by ;

ClientCertificateMode string

The Client Certificate mode. Possible values are Required, Optional, and OptionalInteractiveUser. This property has no effect when client_cert_enabled is false

ConnectionStrings List<WindowsWebAppConnectionStringArgs>

One or more connection_string blocks as defined below.

CustomDomainVerificationId string

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

DefaultHostname string

The default hostname of the Windows Web App.

Enabled bool

Should the Windows Web App be enabled? Defaults to true.

HttpsOnly bool

Should the Windows Web App require HTTPS connections.

Identity WindowsWebAppIdentityArgs

An identity block as defined below.

KeyVaultReferenceIdentityId string

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

Kind string

The Kind value for this Windows Web App.

Location string

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

Logs WindowsWebAppLogsArgs

A logs block as defined below.

Name string

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

OutboundIpAddressLists List<string>

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12"]

OutboundIpAddresses string

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

PossibleOutboundIpAddressLists List<string>

A possible_outbound_ip_address_list block as defined below.

PossibleOutboundIpAddresses string

A comma separated list of outbound IP addresses - such as 52.23.25.3,52.143.43.12,52.143.43.17 - not all of which are necessarily in use. Superset of outbound_ip_addresses.

ResourceGroupName string

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

ServicePlanId string

The ID of the Service Plan that this Windows App Service will be created in.

SiteConfig WindowsWebAppSiteConfigArgs

A site_config block as defined below.

SiteCredentials List<WindowsWebAppSiteCredentialArgs>

A site_credential block as defined below.

StickySettings WindowsWebAppStickySettingsArgs

A sticky_settings block as defined below.

StorageAccounts List<WindowsWebAppStorageAccountArgs>

One or more storage_account blocks as defined below.

Tags Dictionary<string, string>

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

VirtualNetworkSubnetId string

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

ZipDeployFile string

The local path and filename of the Zip packaged application to deploy to this Windows Web App.

AppSettings map[string]string

A map of key-value pairs of App Settings.

AuthSettings WindowsWebAppAuthSettingsArgs

An auth_settings block as defined below.

AuthSettingsV2 WindowsWebAppAuthSettingsV2Args

An auth_settings_v2 block as defined below.

Backup WindowsWebAppBackupArgs

A backup block as defined below.

ClientAffinityEnabled bool

Should Client Affinity be enabled?

ClientCertificateEnabled bool

Should Client Certificates be enabled?

ClientCertificateExclusionPaths string

Paths to exclude when using client certificates, separated by ;

ClientCertificateMode string

The Client Certificate mode. Possible values are Required, Optional, and OptionalInteractiveUser. This property has no effect when client_cert_enabled is false

ConnectionStrings []WindowsWebAppConnectionStringArgs

One or more connection_string blocks as defined below.

CustomDomainVerificationId string

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

DefaultHostname string

The default hostname of the Windows Web App.

Enabled bool

Should the Windows Web App be enabled? Defaults to true.

HttpsOnly bool

Should the Windows Web App require HTTPS connections.

Identity WindowsWebAppIdentityArgs

An identity block as defined below.

KeyVaultReferenceIdentityId string

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

Kind string

The Kind value for this Windows Web App.

Location string

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

Logs WindowsWebAppLogsArgs

A logs block as defined below.

Name string

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

OutboundIpAddressLists []string

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12"]

OutboundIpAddresses string

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

PossibleOutboundIpAddressLists []string

A possible_outbound_ip_address_list block as defined below.

PossibleOutboundIpAddresses string

A comma separated list of outbound IP addresses - such as 52.23.25.3,52.143.43.12,52.143.43.17 - not all of which are necessarily in use. Superset of outbound_ip_addresses.

ResourceGroupName string

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

ServicePlanId string

The ID of the Service Plan that this Windows App Service will be created in.

SiteConfig WindowsWebAppSiteConfigArgs

A site_config block as defined below.

SiteCredentials []WindowsWebAppSiteCredentialArgs

A site_credential block as defined below.

StickySettings WindowsWebAppStickySettingsArgs

A sticky_settings block as defined below.

StorageAccounts []WindowsWebAppStorageAccountArgs

One or more storage_account blocks as defined below.

Tags map[string]string

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

VirtualNetworkSubnetId string

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

ZipDeployFile string

The local path and filename of the Zip packaged application to deploy to this Windows Web App.

appSettings Map<String,String>

A map of key-value pairs of App Settings.

authSettings WindowsWebAppAuthSettingsArgs

An auth_settings block as defined below.

authSettingsV2 WindowsWebAppAuthSettingsV2Args

An auth_settings_v2 block as defined below.

backup WindowsWebAppBackupArgs

A backup block as defined below.

clientAffinityEnabled Boolean

Should Client Affinity be enabled?

clientCertificateEnabled Boolean

Should Client Certificates be enabled?

clientCertificateExclusionPaths String

Paths to exclude when using client certificates, separated by ;

clientCertificateMode String

The Client Certificate mode. Possible values are Required, Optional, and OptionalInteractiveUser. This property has no effect when client_cert_enabled is false

connectionStrings List<WindowsWebAppConnectionStringArgs>

One or more connection_string blocks as defined below.

customDomainVerificationId String

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

defaultHostname String

The default hostname of the Windows Web App.

enabled Boolean

Should the Windows Web App be enabled? Defaults to true.

httpsOnly Boolean

Should the Windows Web App require HTTPS connections.

identity WindowsWebAppIdentityArgs

An identity block as defined below.

keyVaultReferenceIdentityId String

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

kind String

The Kind value for this Windows Web App.

location String

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

logs WindowsWebAppLogsArgs

A logs block as defined below.

name String

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

outboundIpAddressLists List<String>

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12"]

outboundIpAddresses String

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

possibleOutboundIpAddressLists List<String>

A possible_outbound_ip_address_list block as defined below.

possibleOutboundIpAddresses String

A comma separated list of outbound IP addresses - such as 52.23.25.3,52.143.43.12,52.143.43.17 - not all of which are necessarily in use. Superset of outbound_ip_addresses.

resourceGroupName String

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

servicePlanId String

The ID of the Service Plan that this Windows App Service will be created in.

siteConfig WindowsWebAppSiteConfigArgs

A site_config block as defined below.

siteCredentials List<WindowsWebAppSiteCredentialArgs>

A site_credential block as defined below.

stickySettings WindowsWebAppStickySettingsArgs

A sticky_settings block as defined below.

storageAccounts List<WindowsWebAppStorageAccountArgs>

One or more storage_account blocks as defined below.

tags Map<String,String>

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

virtualNetworkSubnetId String

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

zipDeployFile String

The local path and filename of the Zip packaged application to deploy to this Windows Web App.

appSettings {[key: string]: string}

A map of key-value pairs of App Settings.

authSettings WindowsWebAppAuthSettingsArgs

An auth_settings block as defined below.

authSettingsV2 WindowsWebAppAuthSettingsV2Args

An auth_settings_v2 block as defined below.

backup WindowsWebAppBackupArgs

A backup block as defined below.

clientAffinityEnabled boolean

Should Client Affinity be enabled?

clientCertificateEnabled boolean

Should Client Certificates be enabled?

clientCertificateExclusionPaths string

Paths to exclude when using client certificates, separated by ;

clientCertificateMode string

The Client Certificate mode. Possible values are Required, Optional, and OptionalInteractiveUser. This property has no effect when client_cert_enabled is false

connectionStrings WindowsWebAppConnectionStringArgs[]

One or more connection_string blocks as defined below.

customDomainVerificationId string

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

defaultHostname string

The default hostname of the Windows Web App.

enabled boolean

Should the Windows Web App be enabled? Defaults to true.

httpsOnly boolean

Should the Windows Web App require HTTPS connections.

identity WindowsWebAppIdentityArgs

An identity block as defined below.

keyVaultReferenceIdentityId string

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

kind string

The Kind value for this Windows Web App.

location string

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

logs WindowsWebAppLogsArgs

A logs block as defined below.

name string

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

outboundIpAddressLists string[]

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12"]

outboundIpAddresses string

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

possibleOutboundIpAddressLists string[]

A possible_outbound_ip_address_list block as defined below.

possibleOutboundIpAddresses string

A comma separated list of outbound IP addresses - such as 52.23.25.3,52.143.43.12,52.143.43.17 - not all of which are necessarily in use. Superset of outbound_ip_addresses.

resourceGroupName string

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

servicePlanId string

The ID of the Service Plan that this Windows App Service will be created in.

siteConfig WindowsWebAppSiteConfigArgs

A site_config block as defined below.

siteCredentials WindowsWebAppSiteCredentialArgs[]

A site_credential block as defined below.

stickySettings WindowsWebAppStickySettingsArgs

A sticky_settings block as defined below.

storageAccounts WindowsWebAppStorageAccountArgs[]

One or more storage_account blocks as defined below.

tags {[key: string]: string}

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

virtualNetworkSubnetId string

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

zipDeployFile string

The local path and filename of the Zip packaged application to deploy to this Windows Web App.

app_settings Mapping[str, str]

A map of key-value pairs of App Settings.

auth_settings WindowsWebAppAuthSettingsArgs

An auth_settings block as defined below.

auth_settings_v2 WindowsWebAppAuthSettingsV2Args

An auth_settings_v2 block as defined below.

backup WindowsWebAppBackupArgs

A backup block as defined below.

client_affinity_enabled bool

Should Client Affinity be enabled?

client_certificate_enabled bool

Should Client Certificates be enabled?

client_certificate_exclusion_paths str

Paths to exclude when using client certificates, separated by ;

client_certificate_mode str

The Client Certificate mode. Possible values are Required, Optional, and OptionalInteractiveUser. This property has no effect when client_cert_enabled is false

connection_strings Sequence[WindowsWebAppConnectionStringArgs]

One or more connection_string blocks as defined below.

custom_domain_verification_id str

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

default_hostname str

The default hostname of the Windows Web App.

enabled bool

Should the Windows Web App be enabled? Defaults to true.

https_only bool

Should the Windows Web App require HTTPS connections.

identity WindowsWebAppIdentityArgs

An identity block as defined below.

key_vault_reference_identity_id str

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

kind str

The Kind value for this Windows Web App.

location str

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

logs WindowsWebAppLogsArgs

A logs block as defined below.

name str

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

outbound_ip_address_lists Sequence[str]

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12"]

outbound_ip_addresses str

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

possible_outbound_ip_address_lists Sequence[str]

A possible_outbound_ip_address_list block as defined below.

possible_outbound_ip_addresses str

A comma separated list of outbound IP addresses - such as 52.23.25.3,52.143.43.12,52.143.43.17 - not all of which are necessarily in use. Superset of outbound_ip_addresses.

resource_group_name str

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

service_plan_id str

The ID of the Service Plan that this Windows App Service will be created in.

site_config WindowsWebAppSiteConfigArgs

A site_config block as defined below.

site_credentials Sequence[WindowsWebAppSiteCredentialArgs]

A site_credential block as defined below.

sticky_settings WindowsWebAppStickySettingsArgs

A sticky_settings block as defined below.

storage_accounts Sequence[WindowsWebAppStorageAccountArgs]

One or more storage_account blocks as defined below.

tags Mapping[str, str]

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

virtual_network_subnet_id str

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

zip_deploy_file str

The local path and filename of the Zip packaged application to deploy to this Windows Web App.

appSettings Map<String>

A map of key-value pairs of App Settings.

authSettings Property Map

An auth_settings block as defined below.

authSettingsV2 Property Map

An auth_settings_v2 block as defined below.

backup Property Map

A backup block as defined below.

clientAffinityEnabled Boolean

Should Client Affinity be enabled?

clientCertificateEnabled Boolean

Should Client Certificates be enabled?

clientCertificateExclusionPaths String

Paths to exclude when using client certificates, separated by ;

clientCertificateMode String

The Client Certificate mode. Possible values are Required, Optional, and OptionalInteractiveUser. This property has no effect when client_cert_enabled is false

connectionStrings List<Property Map>

One or more connection_string blocks as defined below.

customDomainVerificationId String

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

defaultHostname String

The default hostname of the Windows Web App.

enabled Boolean

Should the Windows Web App be enabled? Defaults to true.

httpsOnly Boolean

Should the Windows Web App require HTTPS connections.

identity Property Map

An identity block as defined below.

keyVaultReferenceIdentityId String

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

kind String

The Kind value for this Windows Web App.

location String

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

logs Property Map

A logs block as defined below.

name String

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

outboundIpAddressLists List<String>

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12"]

outboundIpAddresses String

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

possibleOutboundIpAddressLists List<String>

A possible_outbound_ip_address_list block as defined below.

possibleOutboundIpAddresses String

A comma separated list of outbound IP addresses - such as 52.23.25.3,52.143.43.12,52.143.43.17 - not all of which are necessarily in use. Superset of outbound_ip_addresses.

resourceGroupName String

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

servicePlanId String

The ID of the Service Plan that this Windows App Service will be created in.

siteConfig Property Map

A site_config block as defined below.

siteCredentials List<Property Map>

A site_credential block as defined below.

stickySettings Property Map

A sticky_settings block as defined below.

storageAccounts List<Property Map>

One or more storage_account blocks as defined below.

tags Map<String>

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

virtualNetworkSubnetId String

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

zipDeployFile String

The local path and filename of the Zip packaged application to deploy to this Windows Web App.

Supporting Types

WindowsWebAppAuthSettings

Enabled bool

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

ActiveDirectory WindowsWebAppAuthSettingsActiveDirectory

An active_directory block as defined above.

AdditionalLoginParameters Dictionary<string, string>

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

AllowedExternalRedirectUrls List<string>

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

DefaultProvider string

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

Facebook WindowsWebAppAuthSettingsFacebook

A facebook block as defined below.

Github WindowsWebAppAuthSettingsGithub

A github block as defined below.

Google WindowsWebAppAuthSettingsGoogle

A google block as defined below.

Issuer string

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

Microsoft WindowsWebAppAuthSettingsMicrosoft

A microsoft block as defined below.

RuntimeVersion string

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

TokenRefreshExtensionHours double

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

TokenStoreEnabled bool

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

Twitter WindowsWebAppAuthSettingsTwitter

A twitter block as defined below.

UnauthenticatedClientAction string

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

Enabled bool

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

ActiveDirectory WindowsWebAppAuthSettingsActiveDirectory

An active_directory block as defined above.

AdditionalLoginParameters map[string]string

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

AllowedExternalRedirectUrls []string

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

DefaultProvider string

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

Facebook WindowsWebAppAuthSettingsFacebook

A facebook block as defined below.

Github WindowsWebAppAuthSettingsGithub

A github block as defined below.

Google WindowsWebAppAuthSettingsGoogle

A google block as defined below.

Issuer string

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

Microsoft WindowsWebAppAuthSettingsMicrosoft

A microsoft block as defined below.

RuntimeVersion string

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

TokenRefreshExtensionHours float64

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

TokenStoreEnabled bool

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

Twitter WindowsWebAppAuthSettingsTwitter

A twitter block as defined below.

UnauthenticatedClientAction string

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

enabled Boolean

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

activeDirectory WindowsWebAppAuthSettingsActiveDirectory

An active_directory block as defined above.

additionalLoginParameters Map<String,String>

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

allowedExternalRedirectUrls List<String>

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

defaultProvider String

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

facebook WindowsWebAppAuthSettingsFacebook

A facebook block as defined below.

github WindowsWebAppAuthSettingsGithub

A github block as defined below.

google WindowsWebAppAuthSettingsGoogle

A google block as defined below.

issuer String

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

microsoft WindowsWebAppAuthSettingsMicrosoft

A microsoft block as defined below.

runtimeVersion String

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

tokenRefreshExtensionHours Double

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

tokenStoreEnabled Boolean

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

twitter WindowsWebAppAuthSettingsTwitter

A twitter block as defined below.

unauthenticatedClientAction String

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

enabled boolean

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

activeDirectory WindowsWebAppAuthSettingsActiveDirectory

An active_directory block as defined above.

additionalLoginParameters {[key: string]: string}

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

allowedExternalRedirectUrls string[]

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

defaultProvider string

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

facebook WindowsWebAppAuthSettingsFacebook

A facebook block as defined below.

github WindowsWebAppAuthSettingsGithub

A github block as defined below.

google WindowsWebAppAuthSettingsGoogle

A google block as defined below.

issuer string

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

microsoft WindowsWebAppAuthSettingsMicrosoft

A microsoft block as defined below.

runtimeVersion string

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

tokenRefreshExtensionHours number

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

tokenStoreEnabled boolean

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

twitter WindowsWebAppAuthSettingsTwitter

A twitter block as defined below.

unauthenticatedClientAction string

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

enabled bool

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

active_directory WindowsWebAppAuthSettingsActiveDirectory

An active_directory block as defined above.

additional_login_parameters Mapping[str, str]

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

allowed_external_redirect_urls Sequence[str]

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

default_provider str

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

facebook WindowsWebAppAuthSettingsFacebook

A facebook block as defined below.

github WindowsWebAppAuthSettingsGithub

A github block as defined below.

google WindowsWebAppAuthSettingsGoogle

A google block as defined below.

issuer str

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

microsoft WindowsWebAppAuthSettingsMicrosoft

A microsoft block as defined below.

runtime_version str

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

token_refresh_extension_hours float

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

token_store_enabled bool

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

twitter WindowsWebAppAuthSettingsTwitter

A twitter block as defined below.

unauthenticated_client_action str

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

enabled Boolean

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

activeDirectory Property Map

An active_directory block as defined above.

additionalLoginParameters Map<String>

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

allowedExternalRedirectUrls List<String>

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

defaultProvider String

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

facebook Property Map

A facebook block as defined below.

github Property Map

A github block as defined below.

google Property Map

A google block as defined below.

issuer String

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

microsoft Property Map

A microsoft block as defined below.

runtimeVersion String

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

tokenRefreshExtensionHours Number

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

tokenStoreEnabled Boolean

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

twitter Property Map

A twitter block as defined below.

unauthenticatedClientAction String

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

WindowsWebAppAuthSettingsActiveDirectory

ClientId string

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

AllowedAudiences List<string>

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

ClientSecret string

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

ClientSecretSettingName string

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

ClientId string

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

AllowedAudiences []string

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

ClientSecret string

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

ClientSecretSettingName string

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

clientId String

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

allowedAudiences List<String>

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

clientSecret String

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

clientSecretSettingName String

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

clientId string

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

allowedAudiences string[]

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

clientSecret string

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

clientSecretSettingName string

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

client_id str

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

allowed_audiences Sequence[str]

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

client_secret str

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

client_secret_setting_name str

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

clientId String

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

allowedAudiences List<String>

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

clientSecret String

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

clientSecretSettingName String

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

WindowsWebAppAuthSettingsFacebook

AppId string

The App ID of the Facebook app used for login.

AppSecret string

The App Secret of the Facebook app used for Facebook login. Cannot be specified with app_secret_setting_name.

AppSecretSettingName string

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

OauthScopes List<string>

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

AppId string

The App ID of the Facebook app used for login.

AppSecret string

The App Secret of the Facebook app used for Facebook login. Cannot be specified with app_secret_setting_name.

AppSecretSettingName string

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

OauthScopes []string

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

appId String

The App ID of the Facebook app used for login.

appSecret String

The App Secret of the Facebook app used for Facebook login. Cannot be specified with app_secret_setting_name.

appSecretSettingName String

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

oauthScopes List<String>

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

appId string

The App ID of the Facebook app used for login.

appSecret string

The App Secret of the Facebook app used for Facebook login. Cannot be specified with app_secret_setting_name.

appSecretSettingName string

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

oauthScopes string[]

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

app_id str

The App ID of the Facebook app used for login.

app_secret str

The App Secret of the Facebook app used for Facebook login. Cannot be specified with app_secret_setting_name.

app_secret_setting_name str

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

oauth_scopes Sequence[str]

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

appId String

The App ID of the Facebook app used for login.

appSecret String

The App Secret of the Facebook app used for Facebook login. Cannot be specified with app_secret_setting_name.

appSecretSettingName String

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

oauthScopes List<String>

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

WindowsWebAppAuthSettingsGithub

ClientId string

The ID of the GitHub app used for login.

ClientSecret string

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

ClientSecretSettingName string

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

OauthScopes List<string>

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

ClientId string

The ID of the GitHub app used for login.

ClientSecret string

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

ClientSecretSettingName string

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

OauthScopes []string

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

clientId String

The ID of the GitHub app used for login.

clientSecret String

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

clientSecretSettingName String

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

oauthScopes List<String>

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

clientId string

The ID of the GitHub app used for login.

clientSecret string

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

clientSecretSettingName string

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

oauthScopes string[]

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

client_id str

The ID of the GitHub app used for login.

client_secret str

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

client_secret_setting_name str

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

oauth_scopes Sequence[str]

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

clientId String

The ID of the GitHub app used for login.

clientSecret String

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

clientSecretSettingName String

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

oauthScopes List<String>

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

WindowsWebAppAuthSettingsGoogle

ClientId string

The OpenID Connect Client ID for the Google web application.

ClientSecret string

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

ClientSecretSettingName string

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

OauthScopes List<string>

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

ClientId string

The OpenID Connect Client ID for the Google web application.

ClientSecret string

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

ClientSecretSettingName string

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

OauthScopes []string

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

clientId String

The OpenID Connect Client ID for the Google web application.

clientSecret String

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

clientSecretSettingName String

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

oauthScopes List<String>

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

clientId string

The OpenID Connect Client ID for the Google web application.

clientSecret string

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

clientSecretSettingName string

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

oauthScopes string[]

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

client_id str

The OpenID Connect Client ID for the Google web application.

client_secret str

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

client_secret_setting_name str

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

oauth_scopes Sequence[str]

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

clientId String

The OpenID Connect Client ID for the Google web application.

clientSecret String

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

clientSecretSettingName String

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

oauthScopes List<String>

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

WindowsWebAppAuthSettingsMicrosoft

ClientId string

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

ClientSecret string

The OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with client_secret_setting_name.

ClientSecretSettingName string

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

OauthScopes List<string>

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

ClientId string

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

ClientSecret string

The OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with client_secret_setting_name.

ClientSecretSettingName string

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

OauthScopes []string

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

clientId String

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

clientSecret String

The OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with client_secret_setting_name.

clientSecretSettingName String

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

oauthScopes List<String>

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

clientId string

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

clientSecret string

The OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with client_secret_setting_name.

clientSecretSettingName string

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

oauthScopes string[]

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

client_id str

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

client_secret str

The OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with client_secret_setting_name.

client_secret_setting_name str

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

oauth_scopes Sequence[str]

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

clientId String

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

clientSecret String

The OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with client_secret_setting_name.

clientSecretSettingName String

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

oauthScopes List<String>

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

WindowsWebAppAuthSettingsTwitter

ConsumerKey string

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

ConsumerSecret string

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

ConsumerSecretSettingName string

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

ConsumerKey string

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

ConsumerSecret string

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

ConsumerSecretSettingName string

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

consumerKey String

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

consumerSecret String

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

consumerSecretSettingName String

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

consumerKey string

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

consumerSecret string

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

consumerSecretSettingName string

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

consumer_key str

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

consumer_secret str

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

consumer_secret_setting_name str

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

consumerKey String

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

consumerSecret String

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

consumerSecretSettingName String

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

WindowsWebAppAuthSettingsV2

Login WindowsWebAppAuthSettingsV2Login

A login block as defined below.

ActiveDirectoryV2 WindowsWebAppAuthSettingsV2ActiveDirectoryV2

An active_directory_v2 block as defined below.

AppleV2 WindowsWebAppAuthSettingsV2AppleV2

An apple_v2 block as defined below.

AuthEnabled bool

Should the AuthV2 Settings be enabled. Defaults to false.

AzureStaticWebAppV2 WindowsWebAppAuthSettingsV2AzureStaticWebAppV2

An azure_static_web_app_v2 block as defined below.

ConfigFilePath string

The path to the App Auth settings.

CustomOidcV2s List<WindowsWebAppAuthSettingsV2CustomOidcV2>

Zero or more custom_oidc_v2 blocks as defined below.

DefaultProvider string

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

ExcludedPaths List<string>

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

FacebookV2 WindowsWebAppAuthSettingsV2FacebookV2

A facebook_v2 block as defined below.

ForwardProxyConvention string

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

ForwardProxyCustomHostHeaderName string

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

ForwardProxyCustomSchemeHeaderName string

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

GithubV2 WindowsWebAppAuthSettingsV2GithubV2

A github_v2 block as defined below.

GoogleV2 WindowsWebAppAuthSettingsV2GoogleV2

A google_v2 block as defined below.

HttpRouteApiPrefix string

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

MicrosoftV2 WindowsWebAppAuthSettingsV2MicrosoftV2

A microsoft_v2 block as defined below.

RequireAuthentication bool

Should the authentication flow be used for all requests.

RequireHttps bool

Should HTTPS be required on connections? Defaults to true.

RuntimeVersion string

The RuntimeVersion of the Authentication / Authorization feature in use for the Windows Web App.

TwitterV2 WindowsWebAppAuthSettingsV2TwitterV2

A twitter_v2 block as defined below.

UnauthenticatedAction string

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

Login WindowsWebAppAuthSettingsV2Login

A login block as defined below.

ActiveDirectoryV2 WindowsWebAppAuthSettingsV2ActiveDirectoryV2

An active_directory_v2 block as defined below.

AppleV2 WindowsWebAppAuthSettingsV2AppleV2

An apple_v2 block as defined below.

AuthEnabled bool

Should the AuthV2 Settings be enabled. Defaults to false.

AzureStaticWebAppV2 WindowsWebAppAuthSettingsV2AzureStaticWebAppV2

An azure_static_web_app_v2 block as defined below.

ConfigFilePath string

The path to the App Auth settings.

CustomOidcV2s []WindowsWebAppAuthSettingsV2CustomOidcV2

Zero or more custom_oidc_v2 blocks as defined below.

DefaultProvider string

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

ExcludedPaths []string

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

FacebookV2 WindowsWebAppAuthSettingsV2FacebookV2

A facebook_v2 block as defined below.

ForwardProxyConvention string

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

ForwardProxyCustomHostHeaderName string

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

ForwardProxyCustomSchemeHeaderName string

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

GithubV2 WindowsWebAppAuthSettingsV2GithubV2

A github_v2 block as defined below.

GoogleV2 WindowsWebAppAuthSettingsV2GoogleV2

A google_v2 block as defined below.

HttpRouteApiPrefix string

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

MicrosoftV2 WindowsWebAppAuthSettingsV2MicrosoftV2

A microsoft_v2 block as defined below.

RequireAuthentication bool

Should the authentication flow be used for all requests.

RequireHttps bool

Should HTTPS be required on connections? Defaults to true.

RuntimeVersion string

The RuntimeVersion of the Authentication / Authorization feature in use for the Windows Web App.

TwitterV2 WindowsWebAppAuthSettingsV2TwitterV2

A twitter_v2 block as defined below.

UnauthenticatedAction string

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

login WindowsWebAppAuthSettingsV2Login

A login block as defined below.

activeDirectoryV2 WindowsWebAppAuthSettingsV2ActiveDirectoryV2

An active_directory_v2 block as defined below.

appleV2 WindowsWebAppAuthSettingsV2AppleV2

An apple_v2 block as defined below.

authEnabled Boolean

Should the AuthV2 Settings be enabled. Defaults to false.

azureStaticWebAppV2 WindowsWebAppAuthSettingsV2AzureStaticWebAppV2

An azure_static_web_app_v2 block as defined below.

configFilePath String

The path to the App Auth settings.

customOidcV2s List<WindowsWebAppAuthSettingsV2CustomOidcV2>

Zero or more custom_oidc_v2 blocks as defined below.

defaultProvider String

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

excludedPaths List<String>

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

facebookV2 WindowsWebAppAuthSettingsV2FacebookV2

A facebook_v2 block as defined below.

forwardProxyConvention String

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

forwardProxyCustomHostHeaderName String

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

forwardProxyCustomSchemeHeaderName String

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

githubV2 WindowsWebAppAuthSettingsV2GithubV2

A github_v2 block as defined below.

googleV2 WindowsWebAppAuthSettingsV2GoogleV2

A google_v2 block as defined below.

httpRouteApiPrefix String

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

microsoftV2 WindowsWebAppAuthSettingsV2MicrosoftV2

A microsoft_v2 block as defined below.

requireAuthentication Boolean

Should the authentication flow be used for all requests.

requireHttps Boolean

Should HTTPS be required on connections? Defaults to true.

runtimeVersion String

The RuntimeVersion of the Authentication / Authorization feature in use for the Windows Web App.

twitterV2 WindowsWebAppAuthSettingsV2TwitterV2

A twitter_v2 block as defined below.

unauthenticatedAction String

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

login WindowsWebAppAuthSettingsV2Login

A login block as defined below.

activeDirectoryV2 WindowsWebAppAuthSettingsV2ActiveDirectoryV2

An active_directory_v2 block as defined below.

appleV2 WindowsWebAppAuthSettingsV2AppleV2

An apple_v2 block as defined below.

authEnabled boolean

Should the AuthV2 Settings be enabled. Defaults to false.

azureStaticWebAppV2 WindowsWebAppAuthSettingsV2AzureStaticWebAppV2

An azure_static_web_app_v2 block as defined below.

configFilePath string

The path to the App Auth settings.

customOidcV2s WindowsWebAppAuthSettingsV2CustomOidcV2[]

Zero or more custom_oidc_v2 blocks as defined below.

defaultProvider string

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

excludedPaths string[]

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

facebookV2 WindowsWebAppAuthSettingsV2FacebookV2

A facebook_v2 block as defined below.

forwardProxyConvention string

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

forwardProxyCustomHostHeaderName string

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

forwardProxyCustomSchemeHeaderName string

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

githubV2 WindowsWebAppAuthSettingsV2GithubV2

A github_v2 block as defined below.

googleV2 WindowsWebAppAuthSettingsV2GoogleV2

A google_v2 block as defined below.

httpRouteApiPrefix string

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

microsoftV2 WindowsWebAppAuthSettingsV2MicrosoftV2

A microsoft_v2 block as defined below.

requireAuthentication boolean

Should the authentication flow be used for all requests.

requireHttps boolean

Should HTTPS be required on connections? Defaults to true.

runtimeVersion string

The RuntimeVersion of the Authentication / Authorization feature in use for the Windows Web App.

twitterV2 WindowsWebAppAuthSettingsV2TwitterV2

A twitter_v2 block as defined below.

unauthenticatedAction string

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

login WindowsWebAppAuthSettingsV2Login

A login block as defined below.

active_directory_v2 WindowsWebAppAuthSettingsV2ActiveDirectoryV2

An active_directory_v2 block as defined below.

apple_v2 WindowsWebAppAuthSettingsV2AppleV2

An apple_v2 block as defined below.

auth_enabled bool

Should the AuthV2 Settings be enabled. Defaults to false.

azure_static_web_app_v2 WindowsWebAppAuthSettingsV2AzureStaticWebAppV2

An azure_static_web_app_v2 block as defined below.

config_file_path str

The path to the App Auth settings.

custom_oidc_v2s Sequence[WindowsWebAppAuthSettingsV2CustomOidcV2]

Zero or more custom_oidc_v2 blocks as defined below.

default_provider str

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

excluded_paths Sequence[str]

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

facebook_v2 WindowsWebAppAuthSettingsV2FacebookV2

A facebook_v2 block as defined below.

forward_proxy_convention str

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

forward_proxy_custom_host_header_name str

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

forward_proxy_custom_scheme_header_name str

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

github_v2 WindowsWebAppAuthSettingsV2GithubV2

A github_v2 block as defined below.

google_v2 WindowsWebAppAuthSettingsV2GoogleV2

A google_v2 block as defined below.

http_route_api_prefix str

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

microsoft_v2 WindowsWebAppAuthSettingsV2MicrosoftV2

A microsoft_v2 block as defined below.

require_authentication bool

Should the authentication flow be used for all requests.

require_https bool

Should HTTPS be required on connections? Defaults to true.

runtime_version str

The RuntimeVersion of the Authentication / Authorization feature in use for the Windows Web App.

twitter_v2 WindowsWebAppAuthSettingsV2TwitterV2

A twitter_v2 block as defined below.

unauthenticated_action str

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

login Property Map

A login block as defined below.

activeDirectoryV2 Property Map

An active_directory_v2 block as defined below.

appleV2 Property Map

An apple_v2 block as defined below.

authEnabled Boolean

Should the AuthV2 Settings be enabled. Defaults to false.

azureStaticWebAppV2 Property Map

An azure_static_web_app_v2 block as defined below.

configFilePath String

The path to the App Auth settings.

customOidcV2s List<Property Map>

Zero or more custom_oidc_v2 blocks as defined below.

defaultProvider String

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

excludedPaths List<String>

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

facebookV2 Property Map

A facebook_v2 block as defined below.

forwardProxyConvention String

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

forwardProxyCustomHostHeaderName String

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

forwardProxyCustomSchemeHeaderName String

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

githubV2 Property Map

A github_v2 block as defined below.

googleV2 Property Map

A google_v2 block as defined below.

httpRouteApiPrefix String

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

microsoftV2 Property Map

A microsoft_v2 block as defined below.

requireAuthentication Boolean

Should the authentication flow be used for all requests.

requireHttps Boolean

Should HTTPS be required on connections? Defaults to true.

runtimeVersion String

The RuntimeVersion of the Authentication / Authorization feature in use for the Windows Web App.

twitterV2 Property Map

A twitter_v2 block as defined below.

unauthenticatedAction String

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

WindowsWebAppAuthSettingsV2ActiveDirectoryV2

ClientId string

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

TenantAuthEndpoint string

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

AllowedApplications List<string>

The list of allowed Applications for the Default Authorisation Policy.

AllowedAudiences List<string>

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

AllowedGroups List<string>

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

AllowedIdentities List<string>

The list of allowed Identities for the Default Authorisation Policy.

ClientSecretCertificateThumbprint string

The thumbprint of the certificate used for signing purposes.

ClientSecretSettingName string

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

JwtAllowedClientApplications List<string>

A list of Allowed Client Applications in the JWT Claim.

JwtAllowedGroups List<string>

A list of Allowed Groups in the JWT Claim.

LoginParameters Dictionary<string, string>

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

WwwAuthenticationDisabled bool

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

ClientId string

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

TenantAuthEndpoint string

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

AllowedApplications []string

The list of allowed Applications for the Default Authorisation Policy.

AllowedAudiences []string

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

AllowedGroups []string

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

AllowedIdentities []string

The list of allowed Identities for the Default Authorisation Policy.

ClientSecretCertificateThumbprint string

The thumbprint of the certificate used for signing purposes.

ClientSecretSettingName string

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

JwtAllowedClientApplications []string

A list of Allowed Client Applications in the JWT Claim.

JwtAllowedGroups []string

A list of Allowed Groups in the JWT Claim.

LoginParameters map[string]string

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

WwwAuthenticationDisabled bool

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

clientId String

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

tenantAuthEndpoint String

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

allowedApplications List<String>

The list of allowed Applications for the Default Authorisation Policy.

allowedAudiences List<String>

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

allowedGroups List<String>

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

allowedIdentities List<String>

The list of allowed Identities for the Default Authorisation Policy.

clientSecretCertificateThumbprint String

The thumbprint of the certificate used for signing purposes.

clientSecretSettingName String

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

jwtAllowedClientApplications List<String>

A list of Allowed Client Applications in the JWT Claim.

jwtAllowedGroups List<String>

A list of Allowed Groups in the JWT Claim.

loginParameters Map<String,String>

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

wwwAuthenticationDisabled Boolean

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

clientId string

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

tenantAuthEndpoint string

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

allowedApplications string[]

The list of allowed Applications for the Default Authorisation Policy.

allowedAudiences string[]

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

allowedGroups string[]

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

allowedIdentities string[]

The list of allowed Identities for the Default Authorisation Policy.

clientSecretCertificateThumbprint string

The thumbprint of the certificate used for signing purposes.

clientSecretSettingName string

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

jwtAllowedClientApplications string[]

A list of Allowed Client Applications in the JWT Claim.

jwtAllowedGroups string[]

A list of Allowed Groups in the JWT Claim.

loginParameters {[key: string]: string}

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

wwwAuthenticationDisabled boolean

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

client_id str

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

tenant_auth_endpoint str

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

allowed_applications Sequence[str]

The list of allowed Applications for the Default Authorisation Policy.

allowed_audiences Sequence[str]

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

allowed_groups Sequence[str]

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

allowed_identities Sequence[str]

The list of allowed Identities for the Default Authorisation Policy.

client_secret_certificate_thumbprint str

The thumbprint of the certificate used for signing purposes.

client_secret_setting_name str

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

jwt_allowed_client_applications Sequence[str]

A list of Allowed Client Applications in the JWT Claim.

jwt_allowed_groups Sequence[str]

A list of Allowed Groups in the JWT Claim.

login_parameters Mapping[str, str]

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

www_authentication_disabled bool

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

clientId String

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

tenantAuthEndpoint String

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

allowedApplications List<String>

The list of allowed Applications for the Default Authorisation Policy.

allowedAudiences List<String>

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

allowedGroups List<String>

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

allowedIdentities List<String>

The list of allowed Identities for the Default Authorisation Policy.

clientSecretCertificateThumbprint String

The thumbprint of the certificate used for signing purposes.

clientSecretSettingName String

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

jwtAllowedClientApplications List<String>

A list of Allowed Client Applications in the JWT Claim.

jwtAllowedGroups List<String>

A list of Allowed Groups in the JWT Claim.

loginParameters Map<String>

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

wwwAuthenticationDisabled Boolean

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

WindowsWebAppAuthSettingsV2AppleV2

ClientId string

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

ClientSecretSettingName string

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

LoginScopes List<string>

A list of Login Scopes provided by this Authentication Provider.

ClientId string

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

ClientSecretSettingName string

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

LoginScopes []string

A list of Login Scopes provided by this Authentication Provider.

clientId String

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

clientSecretSettingName String

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

loginScopes List<String>

A list of Login Scopes provided by this Authentication Provider.

clientId string

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

clientSecretSettingName string

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

loginScopes string[]

A list of Login Scopes provided by this Authentication Provider.

client_id str

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

client_secret_setting_name str

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

login_scopes Sequence[str]

A list of Login Scopes provided by this Authentication Provider.

clientId String

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

clientSecretSettingName String

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

loginScopes List<String>

A list of Login Scopes provided by this Authentication Provider.

WindowsWebAppAuthSettingsV2AzureStaticWebAppV2

ClientId string

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

ClientId string

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

clientId String

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

clientId string

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

client_id str

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

clientId String

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

WindowsWebAppAuthSettingsV2CustomOidcV2

ClientId string

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

Name string

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

OpenidConfigurationEndpoint string

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

AuthorisationEndpoint string

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

CertificationUri string

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

ClientCredentialMethod string

The Client Credential Method used.

ClientSecretSettingName string

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

IssuerEndpoint string

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

NameClaimType string

The name of the claim that contains the users name.

Scopes List<string>

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

TokenEndpoint string

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

ClientId string

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

Name string

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

OpenidConfigurationEndpoint string

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

AuthorisationEndpoint string

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

CertificationUri string

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

ClientCredentialMethod string

The Client Credential Method used.

ClientSecretSettingName string

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

IssuerEndpoint string

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

NameClaimType string

The name of the claim that contains the users name.

Scopes []string

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

TokenEndpoint string

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

clientId String

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

name String

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

openidConfigurationEndpoint String

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

authorisationEndpoint String

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

certificationUri String

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

clientCredentialMethod String

The Client Credential Method used.

clientSecretSettingName String

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

issuerEndpoint String

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

nameClaimType String

The name of the claim that contains the users name.

scopes List<String>

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

tokenEndpoint String

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

clientId string

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

name string

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

openidConfigurationEndpoint string

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

authorisationEndpoint string

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

certificationUri string

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

clientCredentialMethod string

The Client Credential Method used.

clientSecretSettingName string

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

issuerEndpoint string

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

nameClaimType string

The name of the claim that contains the users name.

scopes string[]

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

tokenEndpoint string

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

client_id str

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

name str

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

openid_configuration_endpoint str

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

authorisation_endpoint str

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

certification_uri str

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

client_credential_method str

The Client Credential Method used.

client_secret_setting_name str

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

issuer_endpoint str

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

name_claim_type str

The name of the claim that contains the users name.

scopes Sequence[str]

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

token_endpoint str

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

clientId String

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

name String

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

openidConfigurationEndpoint String

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

authorisationEndpoint String

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

certificationUri String

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

clientCredentialMethod String

The Client Credential Method used.

clientSecretSettingName String

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

issuerEndpoint String

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

nameClaimType String

The name of the claim that contains the users name.

scopes List<String>

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

tokenEndpoint String

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

WindowsWebAppAuthSettingsV2FacebookV2

AppId string

The App ID of the Facebook app used for login.

AppSecretSettingName string

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

GraphApiVersion string

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

LoginScopes List<string>

A list of Login Scopes provided by this Authentication Provider.

AppId string

The App ID of the Facebook app used for login.

AppSecretSettingName string

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

GraphApiVersion string

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

LoginScopes []string

A list of Login Scopes provided by this Authentication Provider.

appId String

The App ID of the Facebook app used for login.

appSecretSettingName String

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

graphApiVersion String

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

loginScopes List<String>

A list of Login Scopes provided by this Authentication Provider.

appId string

The App ID of the Facebook app used for login.

appSecretSettingName string

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

graphApiVersion string

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

loginScopes string[]

A list of Login Scopes provided by this Authentication Provider.

app_id str

The App ID of the Facebook app used for login.

app_secret_setting_name str

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

graph_api_version str

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

login_scopes Sequence[str]

A list of Login Scopes provided by this Authentication Provider.

appId String

The App ID of the Facebook app used for login.

appSecretSettingName String

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

graphApiVersion String

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

loginScopes List<String>

A list of Login Scopes provided by this Authentication Provider.

WindowsWebAppAuthSettingsV2GithubV2

ClientId string

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

ClientSecretSettingName string

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

LoginScopes List<string>

A list of Login Scopes provided by this Authentication Provider.

ClientId string

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

ClientSecretSettingName string

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

LoginScopes []string

A list of Login Scopes provided by this Authentication Provider.

clientId String

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

clientSecretSettingName String

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

loginScopes List<String>

A list of Login Scopes provided by this Authentication Provider.

clientId string

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

clientSecretSettingName string

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

loginScopes string[]

A list of Login Scopes provided by this Authentication Provider.

client_id str

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

client_secret_setting_name str

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

login_scopes Sequence[str]

A list of Login Scopes provided by this Authentication Provider.

clientId String

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

clientSecretSettingName String

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

loginScopes List<String>

A list of Login Scopes provided by this Authentication Provider.

WindowsWebAppAuthSettingsV2GoogleV2

ClientId string

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

ClientSecretSettingName string

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

AllowedAudiences List<string>

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

LoginScopes List<string>

A list of Login Scopes provided by this Authentication Provider.

ClientId string

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

ClientSecretSettingName string

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

AllowedAudiences []string

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

LoginScopes []string

A list of Login Scopes provided by this Authentication Provider.

clientId String

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

clientSecretSettingName String

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

allowedAudiences List<String>

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

loginScopes List<String>

A list of Login Scopes provided by this Authentication Provider.

clientId string

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

clientSecretSettingName string

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

allowedAudiences string[]

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

loginScopes string[]

A list of Login Scopes provided by this Authentication Provider.

client_id str

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

client_secret_setting_name str

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

allowed_audiences Sequence[str]

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

login_scopes Sequence[str]

A list of Login Scopes provided by this Authentication Provider.

clientId String

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

clientSecretSettingName String

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

allowedAudiences List<String>

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

loginScopes List<String>

A list of Login Scopes provided by this Authentication Provider.

WindowsWebAppAuthSettingsV2Login

AllowedExternalRedirectUrls List<string>

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

CookieExpirationConvention string

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

CookieExpirationTime string

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

LogoutEndpoint string

The endpoint to which logout requests should be made.

NonceExpirationTime string

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

PreserveUrlFragmentsForLogins bool

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

TokenRefreshExtensionTime double

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

TokenStoreEnabled bool

Should the Token Store configuration Enabled. Defaults to false

TokenStorePath string

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

TokenStoreSasSettingName string

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

ValidateNonce bool

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

AllowedExternalRedirectUrls []string

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

CookieExpirationConvention string

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

CookieExpirationTime string

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

LogoutEndpoint string

The endpoint to which logout requests should be made.

NonceExpirationTime string

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

PreserveUrlFragmentsForLogins bool

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

TokenRefreshExtensionTime float64

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

TokenStoreEnabled bool

Should the Token Store configuration Enabled. Defaults to false

TokenStorePath string

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

TokenStoreSasSettingName string

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

ValidateNonce bool

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

allowedExternalRedirectUrls List<String>

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

cookieExpirationConvention String

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

cookieExpirationTime String

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

logoutEndpoint String

The endpoint to which logout requests should be made.

nonceExpirationTime String

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

preserveUrlFragmentsForLogins Boolean

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

tokenRefreshExtensionTime Double

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

tokenStoreEnabled Boolean

Should the Token Store configuration Enabled. Defaults to false

tokenStorePath String

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

tokenStoreSasSettingName String

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

validateNonce Boolean

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

allowedExternalRedirectUrls string[]

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

cookieExpirationConvention string

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

cookieExpirationTime string

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

logoutEndpoint string

The endpoint to which logout requests should be made.

nonceExpirationTime string

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

preserveUrlFragmentsForLogins boolean

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

tokenRefreshExtensionTime number

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

tokenStoreEnabled boolean

Should the Token Store configuration Enabled. Defaults to false

tokenStorePath string

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

tokenStoreSasSettingName string

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

validateNonce boolean

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

allowed_external_redirect_urls Sequence[str]

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

cookie_expiration_convention str

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

cookie_expiration_time str

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

logout_endpoint str

The endpoint to which logout requests should be made.

nonce_expiration_time str

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

preserve_url_fragments_for_logins bool

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

token_refresh_extension_time float

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

token_store_enabled bool

Should the Token Store configuration Enabled. Defaults to false

token_store_path str

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

token_store_sas_setting_name str

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

validate_nonce bool

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

allowedExternalRedirectUrls List<String>

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

cookieExpirationConvention String

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

cookieExpirationTime String

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

logoutEndpoint String

The endpoint to which logout requests should be made.

nonceExpirationTime String

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

preserveUrlFragmentsForLogins Boolean

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

tokenRefreshExtensionTime Number

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

tokenStoreEnabled Boolean

Should the Token Store configuration Enabled. Defaults to false

tokenStorePath String

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

tokenStoreSasSettingName String

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

validateNonce Boolean

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

WindowsWebAppAuthSettingsV2MicrosoftV2

ClientId string

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

ClientSecretSettingName string

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

AllowedAudiences List<string>

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

LoginScopes List<string>

A list of Login Scopes provided by this Authentication Provider.

ClientId string

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

ClientSecretSettingName string

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

AllowedAudiences []string

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

LoginScopes []string

A list of Login Scopes provided by this Authentication Provider.

clientId String

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

clientSecretSettingName String

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

allowedAudiences List<String>

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

loginScopes List<String>

A list of Login Scopes provided by this Authentication Provider.

clientId string

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

clientSecretSettingName string

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

allowedAudiences string[]

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

loginScopes string[]

A list of Login Scopes provided by this Authentication Provider.

client_id str

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

client_secret_setting_name str

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

allowed_audiences Sequence[str]

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

login_scopes Sequence[str]

A list of Login Scopes provided by this Authentication Provider.

clientId String

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

clientSecretSettingName String

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

allowedAudiences List<String>

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

loginScopes List<String>

A list of Login Scopes provided by this Authentication Provider.

WindowsWebAppAuthSettingsV2TwitterV2

ConsumerKey string

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

ConsumerSecretSettingName string

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

ConsumerKey string

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

ConsumerSecretSettingName string

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

consumerKey String

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

consumerSecretSettingName String

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

consumerKey string

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

consumerSecretSettingName string

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

consumer_key str

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

consumer_secret_setting_name str

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

consumerKey String

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

consumerSecretSettingName String

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

WindowsWebAppBackup

Name string

The name which should be used for this Backup.

Schedule WindowsWebAppBackupSchedule

A schedule block as defined below.

StorageAccountUrl string

The SAS URL to the container.

Enabled bool

Should this backup job be enabled? Defaults to true.

Name string

The name which should be used for this Backup.

Schedule WindowsWebAppBackupSchedule

A schedule block as defined below.

StorageAccountUrl string

The SAS URL to the container.

Enabled bool

Should this backup job be enabled? Defaults to true.

name String

The name which should be used for this Backup.

schedule WindowsWebAppBackupSchedule

A schedule block as defined below.

storageAccountUrl String

The SAS URL to the container.

enabled Boolean

Should this backup job be enabled? Defaults to true.

name string

The name which should be used for this Backup.

schedule WindowsWebAppBackupSchedule

A schedule block as defined below.

storageAccountUrl string

The SAS URL to the container.

enabled boolean

Should this backup job be enabled? Defaults to true.

name str

The name which should be used for this Backup.

schedule WindowsWebAppBackupSchedule

A schedule block as defined below.

storage_account_url str

The SAS URL to the container.

enabled bool

Should this backup job be enabled? Defaults to true.

name String

The name which should be used for this Backup.

schedule Property Map

A schedule block as defined below.

storageAccountUrl String

The SAS URL to the container.

enabled Boolean

Should this backup job be enabled? Defaults to true.

WindowsWebAppBackupSchedule

FrequencyInterval int

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

FrequencyUnit string

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

KeepAtLeastOneBackup bool

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

LastExecutionTime string
RetentionPeriodDays int

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

StartTime string

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

FrequencyInterval int

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

FrequencyUnit string

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

KeepAtLeastOneBackup bool

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

LastExecutionTime string
RetentionPeriodDays int

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

StartTime string

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

frequencyInterval Integer

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

frequencyUnit String

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

keepAtLeastOneBackup Boolean

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

lastExecutionTime String
retentionPeriodDays Integer

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

startTime String

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

frequencyInterval number

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

frequencyUnit string

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

keepAtLeastOneBackup boolean

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

lastExecutionTime string
retentionPeriodDays number

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

startTime string

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

frequency_interval int

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

frequency_unit str

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

keep_at_least_one_backup bool

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

last_execution_time str
retention_period_days int

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

start_time str

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

frequencyInterval Number

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

frequencyUnit String

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

keepAtLeastOneBackup Boolean

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

lastExecutionTime String
retentionPeriodDays Number

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

startTime String

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

WindowsWebAppConnectionString

Name string

The name of the Connection String.

Type string

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

Value string

The connection string value.

Name string

The name of the Connection String.

Type string

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

Value string

The connection string value.

name String

The name of the Connection String.

type String

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

value String

The connection string value.

name string

The name of the Connection String.

type string

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

value string

The connection string value.

name str

The name of the Connection String.

type str

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

value str

The connection string value.

name String

The name of the Connection String.

type String

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

value String

The connection string value.

WindowsWebAppIdentity

Type string

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

IdentityIds List<string>

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

PrincipalId string

The Principal ID associated with this Managed Service Identity.

TenantId string

The Tenant ID associated with this Managed Service Identity.

Type string

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

IdentityIds []string

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

PrincipalId string

The Principal ID associated with this Managed Service Identity.

TenantId string

The Tenant ID associated with this Managed Service Identity.

type String

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

identityIds List<String>

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

principalId String

The Principal ID associated with this Managed Service Identity.

tenantId String

The Tenant ID associated with this Managed Service Identity.

type string

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

identityIds string[]

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

principalId string

The Principal ID associated with this Managed Service Identity.

tenantId string

The Tenant ID associated with this Managed Service Identity.

type str

Specifies the type of Managed Service Identity that should be configured on this Windows Web 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 Web App.

principal_id str

The Principal ID associated with this Managed Service Identity.

tenant_id str

The Tenant ID associated with this Managed Service Identity.

type String

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

identityIds List<String>

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

principalId String

The Principal ID associated with this Managed Service Identity.

tenantId String

The Tenant ID associated with this Managed Service Identity.

WindowsWebAppLogs

ApplicationLogs WindowsWebAppLogsApplicationLogs

A application_logs block as defined above.

DetailedErrorMessages bool

Should detailed error messages be enabled.

FailedRequestTracing bool

Should tracing be enabled for failed requests.

HttpLogs WindowsWebAppLogsHttpLogs

A http_logs block as defined above.

ApplicationLogs WindowsWebAppLogsApplicationLogs

A application_logs block as defined above.

DetailedErrorMessages bool

Should detailed error messages be enabled.

FailedRequestTracing bool

Should tracing be enabled for failed requests.

HttpLogs WindowsWebAppLogsHttpLogs

A http_logs block as defined above.

applicationLogs WindowsWebAppLogsApplicationLogs

A application_logs block as defined above.

detailedErrorMessages Boolean

Should detailed error messages be enabled.

failedRequestTracing Boolean

Should tracing be enabled for failed requests.

httpLogs WindowsWebAppLogsHttpLogs

A http_logs block as defined above.

applicationLogs WindowsWebAppLogsApplicationLogs

A application_logs block as defined above.

detailedErrorMessages boolean

Should detailed error messages be enabled.

failedRequestTracing boolean

Should tracing be enabled for failed requests.

httpLogs WindowsWebAppLogsHttpLogs

A http_logs block as defined above.

application_logs WindowsWebAppLogsApplicationLogs

A application_logs block as defined above.

detailed_error_messages bool

Should detailed error messages be enabled.

failed_request_tracing bool

Should tracing be enabled for failed requests.

http_logs WindowsWebAppLogsHttpLogs

A http_logs block as defined above.

applicationLogs Property Map

A application_logs block as defined above.

detailedErrorMessages Boolean

Should detailed error messages be enabled.

failedRequestTracing Boolean

Should tracing be enabled for failed requests.

httpLogs Property Map

A http_logs block as defined above.

WindowsWebAppLogsApplicationLogs

FileSystemLevel string

Log level. Possible values include: Verbose, Information, Warning, and Error.

AzureBlobStorage WindowsWebAppLogsApplicationLogsAzureBlobStorage

An azure_blob_storage block as defined below.

FileSystemLevel string

Log level. Possible values include: Verbose, Information, Warning, and Error.

AzureBlobStorage WindowsWebAppLogsApplicationLogsAzureBlobStorage

An azure_blob_storage block as defined below.

fileSystemLevel String

Log level. Possible values include: Verbose, Information, Warning, and Error.

azureBlobStorage WindowsWebAppLogsApplicationLogsAzureBlobStorage

An azure_blob_storage block as defined below.

fileSystemLevel string

Log level. Possible values include: Verbose, Information, Warning, and Error.

azureBlobStorage WindowsWebAppLogsApplicationLogsAzureBlobStorage

An azure_blob_storage block as defined below.

file_system_level str

Log level. Possible values include: Verbose, Information, Warning, and Error.

azure_blob_storage WindowsWebAppLogsApplicationLogsAzureBlobStorage

An azure_blob_storage block as defined below.

fileSystemLevel String

Log level. Possible values include: Verbose, Information, Warning, and Error.

azureBlobStorage Property Map

An azure_blob_storage block as defined below.

WindowsWebAppLogsApplicationLogsAzureBlobStorage

Level string

The level at which to log. Possible values include Error, Warning, Information, Verbose and Off. NOTE: this field is not available for http_logs

RetentionInDays int

The time in days after which to remove blobs. A value of 0 means no retention.

SasUrl string

SAS url to an Azure blob container with read/write/list/delete permissions.

Level string

The level at which to log. Possible values include Error, Warning, Information, Verbose and Off. NOTE: this field is not available for http_logs

RetentionInDays int

The time in days after which to remove blobs. A value of 0 means no retention.

SasUrl string

SAS url to an Azure blob container with read/write/list/delete permissions.

level String

The level at which to log. Possible values include Error, Warning, Information, Verbose and Off. NOTE: this field is not available for http_logs

retentionInDays Integer

The time in days after which to remove blobs. A value of 0 means no retention.

sasUrl String

SAS url to an Azure blob container with read/write/list/delete permissions.

level string

The level at which to log. Possible values include Error, Warning, Information, Verbose and Off. NOTE: this field is not available for http_logs

retentionInDays number

The time in days after which to remove blobs. A value of 0 means no retention.

sasUrl string

SAS url to an Azure blob container with read/write/list/delete permissions.

level str

The level at which to log. Possible values include Error, Warning, Information, Verbose and Off. NOTE: this field is not available for http_logs

retention_in_days int

The time in days after which to remove blobs. A value of 0 means no retention.

sas_url str

SAS url to an Azure blob container with read/write/list/delete permissions.

level String

The level at which to log. Possible values include Error, Warning, Information, Verbose and Off. NOTE: this field is not available for http_logs

retentionInDays Number

The time in days after which to remove blobs. A value of 0 means no retention.

sasUrl String

SAS url to an Azure blob container with read/write/list/delete permissions.

WindowsWebAppLogsHttpLogs

AzureBlobStorage WindowsWebAppLogsHttpLogsAzureBlobStorage

A azure_blob_storage_http block as defined above.

FileSystem WindowsWebAppLogsHttpLogsFileSystem

A file_system block as defined above.

AzureBlobStorage WindowsWebAppLogsHttpLogsAzureBlobStorage

A azure_blob_storage_http block as defined above.

FileSystem WindowsWebAppLogsHttpLogsFileSystem

A file_system block as defined above.

azureBlobStorage WindowsWebAppLogsHttpLogsAzureBlobStorage

A azure_blob_storage_http block as defined above.

fileSystem WindowsWebAppLogsHttpLogsFileSystem

A file_system block as defined above.

azureBlobStorage WindowsWebAppLogsHttpLogsAzureBlobStorage

A azure_blob_storage_http block as defined above.

fileSystem WindowsWebAppLogsHttpLogsFileSystem

A file_system block as defined above.

azure_blob_storage WindowsWebAppLogsHttpLogsAzureBlobStorage

A azure_blob_storage_http block as defined above.

file_system WindowsWebAppLogsHttpLogsFileSystem

A file_system block as defined above.

azureBlobStorage Property Map

A azure_blob_storage_http block as defined above.

fileSystem Property Map

A file_system block as defined above.

WindowsWebAppLogsHttpLogsAzureBlobStorage

SasUrl string

SAS url to an Azure blob container with read/write/list/delete permissions.

RetentionInDays int

The time in days after which to remove blobs. A value of 0 means no retention.

SasUrl string

SAS url to an Azure blob container with read/write/list/delete permissions.

RetentionInDays int

The time in days after which to remove blobs. A value of 0 means no retention.

sasUrl String

SAS url to an Azure blob container with read/write/list/delete permissions.

retentionInDays Integer

The time in days after which to remove blobs. A value of 0 means no retention.

sasUrl string

SAS url to an Azure blob container with read/write/list/delete permissions.

retentionInDays number

The time in days after which to remove blobs. A value of 0 means no retention.

sas_url str

SAS url to an Azure blob container with read/write/list/delete permissions.

retention_in_days int

The time in days after which to remove blobs. A value of 0 means no retention.

sasUrl String

SAS url to an Azure blob container with read/write/list/delete permissions.

retentionInDays Number

The time in days after which to remove blobs. A value of 0 means no retention.

WindowsWebAppLogsHttpLogsFileSystem

RetentionInDays int

The retention period in days. A values of 0 means no retention.

RetentionInMb int

The maximum size in megabytes that log files can use.

RetentionInDays int

The retention period in days. A values of 0 means no retention.

RetentionInMb int

The maximum size in megabytes that log files can use.

retentionInDays Integer

The retention period in days. A values of 0 means no retention.

retentionInMb Integer

The maximum size in megabytes that log files can use.

retentionInDays number

The retention period in days. A values of 0 means no retention.

retentionInMb number

The maximum size in megabytes that log files can use.

retention_in_days int

The retention period in days. A values of 0 means no retention.

retention_in_mb int

The maximum size in megabytes that log files can use.

retentionInDays Number

The retention period in days. A values of 0 means no retention.

retentionInMb Number

The maximum size in megabytes that log files can use.

WindowsWebAppSiteConfig

AlwaysOn bool

If this Windows Web App is Always On enabled. Defaults to true.

ApiDefinitionUrl string

The URL to the API Definition for this Windows Web App.

ApiManagementApiId string

The API Management API ID this Windows Web App Slot is associated with.

AppCommandLine string

The App command line to launch.

ApplicationStack WindowsWebAppSiteConfigApplicationStack

A application_stack block as defined above.

AutoHealEnabled bool

Should Auto heal rules be enabled. Required with auto_heal_setting.

AutoHealSetting WindowsWebAppSiteConfigAutoHealSetting

A auto_heal_setting block as defined above. Required with auto_heal.

ContainerRegistryManagedIdentityClientId string

The Client ID of the Managed Service Identity to use for connections to the Azure Container Registry.

ContainerRegistryUseManagedIdentity bool

Should connections for Azure Container Registry use Managed Identity.

Cors WindowsWebAppSiteConfigCors

A cors block as defined above.

DefaultDocuments List<string>

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

DetailedErrorLoggingEnabled bool
FtpsState string

The State of FTP / FTPS service. Possible values include: AllAllowed, FtpsOnly, Disabled.

HealthCheckEvictionTimeInMin int

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

HealthCheckPath string

The path to the Health Check.

Http2Enabled bool

Should the HTTP2 be enabled?

IpRestrictions List<WindowsWebAppSiteConfigIpRestriction>

One or more ip_restriction blocks as defined above.

LinuxFxVersion string
LoadBalancingMode string

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

LocalMysqlEnabled bool

Use Local MySQL. Defaults to false.

ManagedPipelineMode string

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

MinimumTlsVersion string

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

RemoteDebuggingEnabled bool

Should Remote Debugging be enabled. Defaults to false.

RemoteDebuggingVersion string

The Remote Debugging Version. Possible values include VS2017 and VS2019

ScmIpRestrictions List<WindowsWebAppSiteConfigScmIpRestriction>

One or more scm_ip_restriction blocks as defined above.

ScmMinimumTlsVersion string

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

ScmType string
ScmUseMainIpRestriction bool

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

Use32BitWorker bool

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

VirtualApplications List<WindowsWebAppSiteConfigVirtualApplication>

One or more virtual_application blocks as defined below.

VnetRouteAllEnabled bool

Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to false.

WebsocketsEnabled bool

Should Web Sockets be enabled. Defaults to false.

WindowsFxVersion string
WorkerCount int

The number of Workers for this Windows App Service.

AlwaysOn bool

If this Windows Web App is Always On enabled. Defaults to true.

ApiDefinitionUrl string

The URL to the API Definition for this Windows Web App.

ApiManagementApiId string

The API Management API ID this Windows Web App Slot is associated with.

AppCommandLine string

The App command line to launch.

ApplicationStack WindowsWebAppSiteConfigApplicationStack

A application_stack block as defined above.

AutoHealEnabled bool

Should Auto heal rules be enabled. Required with auto_heal_setting.

AutoHealSetting WindowsWebAppSiteConfigAutoHealSetting

A auto_heal_setting block as defined above. Required with auto_heal.

ContainerRegistryManagedIdentityClientId string

The Client ID of the Managed Service Identity to use for connections to the Azure Container Registry.

ContainerRegistryUseManagedIdentity bool

Should connections for Azure Container Registry use Managed Identity.

Cors WindowsWebAppSiteConfigCors

A cors block as defined above.

DefaultDocuments []string

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

DetailedErrorLoggingEnabled bool
FtpsState string

The State of FTP / FTPS service. Possible values include: AllAllowed, FtpsOnly, Disabled.

HealthCheckEvictionTimeInMin int

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

HealthCheckPath string

The path to the Health Check.

Http2Enabled bool

Should the HTTP2 be enabled?

IpRestrictions []WindowsWebAppSiteConfigIpRestriction

One or more ip_restriction blocks as defined above.

LinuxFxVersion string
LoadBalancingMode string

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

LocalMysqlEnabled bool

Use Local MySQL. Defaults to false.

ManagedPipelineMode string

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

MinimumTlsVersion string

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

RemoteDebuggingEnabled bool

Should Remote Debugging be enabled. Defaults to false.

RemoteDebuggingVersion string

The Remote Debugging Version. Possible values include VS2017 and VS2019

ScmIpRestrictions []WindowsWebAppSiteConfigScmIpRestriction

One or more scm_ip_restriction blocks as defined above.

ScmMinimumTlsVersion string

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

ScmType string
ScmUseMainIpRestriction bool

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

Use32BitWorker bool

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

VirtualApplications []WindowsWebAppSiteConfigVirtualApplication

One or more virtual_application blocks as defined below.

VnetRouteAllEnabled bool

Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to false.

WebsocketsEnabled bool

Should Web Sockets be enabled. Defaults to false.

WindowsFxVersion string
WorkerCount int

The number of Workers for this Windows App Service.

alwaysOn Boolean

If this Windows Web App is Always On enabled. Defaults to true.

apiDefinitionUrl String

The URL to the API Definition for this Windows Web App.

apiManagementApiId String

The API Management API ID this Windows Web App Slot is associated with.

appCommandLine String

The App command line to launch.

applicationStack WindowsWebAppSiteConfigApplicationStack

A application_stack block as defined above.

autoHealEnabled Boolean

Should Auto heal rules be enabled. Required with auto_heal_setting.

autoHealSetting WindowsWebAppSiteConfigAutoHealSetting

A auto_heal_setting block as defined above. Required with auto_heal.

containerRegistryManagedIdentityClientId String

The Client ID of the Managed Service Identity to use for connections to the Azure Container Registry.

containerRegistryUseManagedIdentity Boolean

Should connections for Azure Container Registry use Managed Identity.

cors WindowsWebAppSiteConfigCors

A cors block as defined above.

defaultDocuments List<String>

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

detailedErrorLoggingEnabled Boolean
ftpsState String

The State of FTP / FTPS service. Possible values include: AllAllowed, FtpsOnly, Disabled.

healthCheckEvictionTimeInMin Integer

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

healthCheckPath String

The path to the Health Check.

http2Enabled Boolean

Should the HTTP2 be enabled?

ipRestrictions List<WindowsWebAppSiteConfigIpRestriction>

One or more ip_restriction blocks as defined above.

linuxFxVersion String
loadBalancingMode String

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

localMysqlEnabled Boolean

Use Local MySQL. Defaults to false.

managedPipelineMode String

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

minimumTlsVersion String

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

remoteDebuggingEnabled Boolean

Should Remote Debugging be enabled. Defaults to false.

remoteDebuggingVersion String

The Remote Debugging Version. Possible values include VS2017 and VS2019

scmIpRestrictions List<WindowsWebAppSiteConfigScmIpRestriction>

One or more scm_ip_restriction blocks as defined above.

scmMinimumTlsVersion String

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

scmType String
scmUseMainIpRestriction Boolean

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

use32BitWorker Boolean

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

virtualApplications List<WindowsWebAppSiteConfigVirtualApplication>

One or more virtual_application blocks as defined below.

vnetRouteAllEnabled Boolean

Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to false.

websocketsEnabled Boolean

Should Web Sockets be enabled. Defaults to false.

windowsFxVersion String
workerCount Integer

The number of Workers for this Windows App Service.

alwaysOn boolean

If this Windows Web App is Always On enabled. Defaults to true.

apiDefinitionUrl string

The URL to the API Definition for this Windows Web App.

apiManagementApiId string

The API Management API ID this Windows Web App Slot is associated with.

appCommandLine string

The App command line to launch.

applicationStack WindowsWebAppSiteConfigApplicationStack

A application_stack block as defined above.

autoHealEnabled boolean

Should Auto heal rules be enabled. Required with auto_heal_setting.

autoHealSetting WindowsWebAppSiteConfigAutoHealSetting

A auto_heal_setting block as defined above. Required with auto_heal.

containerRegistryManagedIdentityClientId string

The Client ID of the Managed Service Identity to use for connections to the Azure Container Registry.

containerRegistryUseManagedIdentity boolean

Should connections for Azure Container Registry use Managed Identity.

cors WindowsWebAppSiteConfigCors

A cors block as defined above.

defaultDocuments string[]

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

detailedErrorLoggingEnabled boolean
ftpsState string

The State of FTP / FTPS service. Possible values include: AllAllowed, FtpsOnly, Disabled.

healthCheckEvictionTimeInMin number

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

healthCheckPath string

The path to the Health Check.

http2Enabled boolean

Should the HTTP2 be enabled?

ipRestrictions WindowsWebAppSiteConfigIpRestriction[]

One or more ip_restriction blocks as defined above.

linuxFxVersion string
loadBalancingMode string

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

localMysqlEnabled boolean

Use Local MySQL. Defaults to false.

managedPipelineMode string

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

minimumTlsVersion string

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

remoteDebuggingEnabled boolean

Should Remote Debugging be enabled. Defaults to false.

remoteDebuggingVersion string

The Remote Debugging Version. Possible values include VS2017 and VS2019

scmIpRestrictions WindowsWebAppSiteConfigScmIpRestriction[]

One or more scm_ip_restriction blocks as defined above.

scmMinimumTlsVersion string

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

scmType string
scmUseMainIpRestriction boolean

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

use32BitWorker boolean

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

virtualApplications WindowsWebAppSiteConfigVirtualApplication[]

One or more virtual_application blocks as defined below.

vnetRouteAllEnabled boolean

Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to false.

websocketsEnabled boolean

Should Web Sockets be enabled. Defaults to false.

windowsFxVersion string
workerCount number

The number of Workers for this Windows App Service.

always_on bool

If this Windows Web App is Always On enabled. Defaults to true.

api_definition_url str

The URL to the API Definition for this Windows Web App.

api_management_api_id str

The API Management API ID this Windows Web App Slot is associated with.

app_command_line str

The App command line to launch.

application_stack WindowsWebAppSiteConfigApplicationStack

A application_stack block as defined above.

auto_heal_enabled bool

Should Auto heal rules be enabled. Required with auto_heal_setting.

auto_heal_setting WindowsWebAppSiteConfigAutoHealSetting

A auto_heal_setting block as defined above. Required with auto_heal.

container_registry_managed_identity_client_id str

The Client ID of the Managed Service Identity to use for connections to the Azure Container Registry.

container_registry_use_managed_identity bool

Should connections for Azure Container Registry use Managed Identity.

cors WindowsWebAppSiteConfigCors

A cors block as defined above.

default_documents Sequence[str]

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

detailed_error_logging_enabled bool
ftps_state str

The State of FTP / FTPS service. Possible values include: AllAllowed, FtpsOnly, Disabled.

health_check_eviction_time_in_min int

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

health_check_path str

The path to the Health Check.

http2_enabled bool

Should the HTTP2 be enabled?

ip_restrictions Sequence[WindowsWebAppSiteConfigIpRestriction]

One or more ip_restriction blocks as defined above.

linux_fx_version str
load_balancing_mode str

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

local_mysql_enabled bool

Use Local MySQL. Defaults to false.

managed_pipeline_mode str

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

minimum_tls_version str

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

remote_debugging_enabled bool

Should Remote Debugging be enabled. Defaults to false.

remote_debugging_version str

The Remote Debugging Version. Possible values include VS2017 and VS2019

scm_ip_restrictions Sequence[WindowsWebAppSiteConfigScmIpRestriction]

One or more scm_ip_restriction blocks as defined above.

scm_minimum_tls_version str

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

scm_type str
scm_use_main_ip_restriction bool

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

use32_bit_worker bool

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

virtual_applications Sequence[WindowsWebAppSiteConfigVirtualApplication]

One or more virtual_application blocks as defined below.

vnet_route_all_enabled bool

Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to false.

websockets_enabled bool

Should Web Sockets be enabled. Defaults to false.

windows_fx_version str
worker_count int

The number of Workers for this Windows App Service.

alwaysOn Boolean

If this Windows Web App is Always On enabled. Defaults to true.

apiDefinitionUrl String

The URL to the API Definition for this Windows Web App.

apiManagementApiId String

The API Management API ID this Windows Web App Slot is associated with.

appCommandLine String

The App command line to launch.

applicationStack Property Map

A application_stack block as defined above.

autoHealEnabled Boolean

Should Auto heal rules be enabled. Required with auto_heal_setting.

autoHealSetting Property Map

A auto_heal_setting block as defined above. Required with auto_heal.

containerRegistryManagedIdentityClientId String

The Client ID of the Managed Service Identity to use for connections to the Azure Container Registry.

containerRegistryUseManagedIdentity Boolean

Should connections for Azure Container Registry use Managed Identity.

cors Property Map

A cors block as defined above.

defaultDocuments List<String>

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

detailedErrorLoggingEnabled Boolean
ftpsState String

The State of FTP / FTPS service. Possible values include: AllAllowed, FtpsOnly, Disabled.

healthCheckEvictionTimeInMin Number

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

healthCheckPath String

The path to the Health Check.

http2Enabled Boolean

Should the HTTP2 be enabled?

ipRestrictions List<Property Map>

One or more ip_restriction blocks as defined above.

linuxFxVersion String
loadBalancingMode String

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

localMysqlEnabled Boolean

Use Local MySQL. Defaults to false.

managedPipelineMode String

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

minimumTlsVersion String

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

remoteDebuggingEnabled Boolean

Should Remote Debugging be enabled. Defaults to false.

remoteDebuggingVersion String

The Remote Debugging Version. Possible values include VS2017 and VS2019

scmIpRestrictions List<Property Map>

One or more scm_ip_restriction blocks as defined above.

scmMinimumTlsVersion String

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

scmType String
scmUseMainIpRestriction Boolean

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

use32BitWorker Boolean

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

virtualApplications List<Property Map>

One or more virtual_application blocks as defined below.

vnetRouteAllEnabled Boolean

Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to false.

websocketsEnabled Boolean

Should Web Sockets be enabled. Defaults to false.

windowsFxVersion String
workerCount Number

The number of Workers for this Windows App Service.

WindowsWebAppSiteConfigApplicationStack

CurrentStack string

The Application Stack for the Windows Web App. Possible values include dotnet, dotnetcore, node, python, php, and java.

DockerContainerName string

The name of the Docker Container. For example azure-app-service/samples/aspnethelloworld

DockerContainerRegistry string

The registry Host on which the specified Docker Container can be located. For example mcr.microsoft.com

DockerContainerTag string

The Image Tag of the specified Docker Container to use. For example latest

DotnetCoreVersion string

The version of .NET to use when current_stack is set to dotnetcore. Possible values include v4.0.

DotnetVersion string

The version of .NET to use when current_stack is set to dotnet. Possible values include v2.0,v3.0, v4.0, v5.0, v6.0 and v7.0.

JavaContainer string

Deprecated:

this property has been deprecated in favour of tomcat_version and java_embedded_server_enabled

JavaContainerVersion string

Deprecated:

This property has been deprecated in favour of tomcat_version and java_embedded_server_enabled

JavaEmbeddedServerEnabled bool

Should the Java Embedded Server (Java SE) be used to run the app.

JavaVersion string

The version of Java to use when current_stack is set to java.

NodeVersion string

The version of node to use when current_stack is set to node. Possible values are ~12, ~14, ~16, and ~18.

PhpVersion string

The version of PHP to use when current_stack is set to php. Possible values are 7.1, 7.4 and Off.

Python bool

Specifies whether this is a Python app. Defaults to false.

PythonVersion string

Deprecated:

This property is deprecated. Values set are not used by the service.

TomcatVersion string

The version of Tomcat the Java App should use. Conflicts with java_embedded_server_enabled

CurrentStack string

The Application Stack for the Windows Web App. Possible values include dotnet, dotnetcore, node, python, php, and java.

DockerContainerName string

The name of the Docker Container. For example azure-app-service/samples/aspnethelloworld

DockerContainerRegistry string

The registry Host on which the specified Docker Container can be located. For example mcr.microsoft.com

DockerContainerTag string

The Image Tag of the specified Docker Container to use. For example latest

DotnetCoreVersion string

The version of .NET to use when current_stack is set to dotnetcore. Possible values include v4.0.

DotnetVersion string

The version of .NET to use when current_stack is set to dotnet. Possible values include v2.0,v3.0, v4.0, v5.0, v6.0 and v7.0.

JavaContainer string

Deprecated:

this property has been deprecated in favour of tomcat_version and java_embedded_server_enabled

JavaContainerVersion string

Deprecated:

This property has been deprecated in favour of tomcat_version and java_embedded_server_enabled

JavaEmbeddedServerEnabled bool

Should the Java Embedded Server (Java SE) be used to run the app.

JavaVersion string

The version of Java to use when current_stack is set to java.

NodeVersion string

The version of node to use when current_stack is set to node. Possible values are ~12, ~14, ~16, and ~18.

PhpVersion string

The version of PHP to use when current_stack is set to php. Possible values are 7.1, 7.4 and Off.

Python bool

Specifies whether this is a Python app. Defaults to false.

PythonVersion string

Deprecated:

This property is deprecated. Values set are not used by the service.

TomcatVersion string

The version of Tomcat the Java App should use. Conflicts with java_embedded_server_enabled

currentStack String

The Application Stack for the Windows Web App. Possible values include dotnet, dotnetcore, node, python, php, and java.

dockerContainerName String

The name of the Docker Container. For example azure-app-service/samples/aspnethelloworld

dockerContainerRegistry String

The registry Host on which the specified Docker Container can be located. For example mcr.microsoft.com

dockerContainerTag String

The Image Tag of the specified Docker Container to use. For example latest

dotnetCoreVersion String

The version of .NET to use when current_stack is set to dotnetcore. Possible values include v4.0.

dotnetVersion String

The version of .NET to use when current_stack is set to dotnet. Possible values include v2.0,v3.0, v4.0, v5.0, v6.0 and v7.0.

javaContainer String

Deprecated:

this property has been deprecated in favour of tomcat_version and java_embedded_server_enabled

javaContainerVersion String

Deprecated:

This property has been deprecated in favour of tomcat_version and java_embedded_server_enabled

javaEmbeddedServerEnabled Boolean

Should the Java Embedded Server (Java SE) be used to run the app.

javaVersion String

The version of Java to use when current_stack is set to java.

nodeVersion String

The version of node to use when current_stack is set to node. Possible values are ~12, ~14, ~16, and ~18.

phpVersion String

The version of PHP to use when current_stack is set to php. Possible values are 7.1, 7.4 and Off.

python Boolean

Specifies whether this is a Python app. Defaults to false.

pythonVersion String

Deprecated:

This property is deprecated. Values set are not used by the service.

tomcatVersion String

The version of Tomcat the Java App should use. Conflicts with java_embedded_server_enabled

currentStack string

The Application Stack for the Windows Web App. Possible values include dotnet, dotnetcore, node, python, php, and java.

dockerContainerName string

The name of the Docker Container. For example azure-app-service/samples/aspnethelloworld

dockerContainerRegistry string

The registry Host on which the specified Docker Container can be located. For example mcr.microsoft.com

dockerContainerTag string

The Image Tag of the specified Docker Container to use. For example latest

dotnetCoreVersion string

The version of .NET to use when current_stack is set to dotnetcore. Possible values include v4.0.

dotnetVersion string

The version of .NET to use when current_stack is set to dotnet. Possible values include v2.0,v3.0, v4.0, v5.0, v6.0 and v7.0.

javaContainer string

Deprecated:

this property has been deprecated in favour of tomcat_version and java_embedded_server_enabled

javaContainerVersion string

Deprecated:

This property has been deprecated in favour of tomcat_version and java_embedded_server_enabled

javaEmbeddedServerEnabled boolean

Should the Java Embedded Server (Java SE) be used to run the app.

javaVersion string

The version of Java to use when current_stack is set to java.

nodeVersion string

The version of node to use when current_stack is set to node. Possible values are ~12, ~14, ~16, and ~18.

phpVersion string

The version of PHP to use when current_stack is set to php. Possible values are 7.1, 7.4 and Off.

python boolean

Specifies whether this is a Python app. Defaults to false.

pythonVersion string

Deprecated:

This property is deprecated. Values set are not used by the service.

tomcatVersion string

The version of Tomcat the Java App should use. Conflicts with java_embedded_server_enabled

current_stack str

The Application Stack for the Windows Web App. Possible values include dotnet, dotnetcore, node, python, php, and java.

docker_container_name str

The name of the Docker Container. For example azure-app-service/samples/aspnethelloworld

docker_container_registry str

The registry Host on which the specified Docker Container can be located. For example mcr.microsoft.com

docker_container_tag str

The Image Tag of the specified Docker Container to use. For example latest

dotnet_core_version str

The version of .NET to use when current_stack is set to dotnetcore. Possible values include v4.0.

dotnet_version str

The version of .NET to use when current_stack is set to dotnet. Possible values include v2.0,v3.0, v4.0, v5.0, v6.0 and v7.0.

java_container str

Deprecated:

this property has been deprecated in favour of tomcat_version and java_embedded_server_enabled

java_container_version str

Deprecated:

This property has been deprecated in favour of tomcat_version and java_embedded_server_enabled

java_embedded_server_enabled bool

Should the Java Embedded Server (Java SE) be used to run the app.

java_version str

The version of Java to use when current_stack is set to java.

node_version str

The version of node to use when current_stack is set to node. Possible values are ~12, ~14, ~16, and ~18.

php_version str

The version of PHP to use when current_stack is set to php. Possible values are 7.1, 7.4 and Off.

python bool

Specifies whether this is a Python app. Defaults to false.

python_version str

Deprecated:

This property is deprecated. Values set are not used by the service.

tomcat_version str

The version of Tomcat the Java App should use. Conflicts with java_embedded_server_enabled

currentStack String

The Application Stack for the Windows Web App. Possible values include dotnet, dotnetcore, node, python, php, and java.

dockerContainerName String

The name of the Docker Container. For example azure-app-service/samples/aspnethelloworld

dockerContainerRegistry String

The registry Host on which the specified Docker Container can be located. For example mcr.microsoft.com

dockerContainerTag String

The Image Tag of the specified Docker Container to use. For example latest

dotnetCoreVersion String

The version of .NET to use when current_stack is set to dotnetcore. Possible values include v4.0.

dotnetVersion String

The version of .NET to use when current_stack is set to dotnet. Possible values include v2.0,v3.0, v4.0, v5.0, v6.0 and v7.0.

javaContainer String

Deprecated:

this property has been deprecated in favour of tomcat_version and java_embedded_server_enabled

javaContainerVersion String

Deprecated:

This property has been deprecated in favour of tomcat_version and java_embedded_server_enabled

javaEmbeddedServerEnabled Boolean

Should the Java Embedded Server (Java SE) be used to run the app.

javaVersion String

The version of Java to use when current_stack is set to java.

nodeVersion String

The version of node to use when current_stack is set to node. Possible values are ~12, ~14, ~16, and ~18.

phpVersion String

The version of PHP to use when current_stack is set to php. Possible values are 7.1, 7.4 and Off.

python Boolean

Specifies whether this is a Python app. Defaults to false.

pythonVersion String

Deprecated:

This property is deprecated. Values set are not used by the service.

tomcatVersion String

The version of Tomcat the Java App should use. Conflicts with java_embedded_server_enabled

WindowsWebAppSiteConfigAutoHealSetting

Action WindowsWebAppSiteConfigAutoHealSettingAction

An action block as defined above.

Trigger WindowsWebAppSiteConfigAutoHealSettingTrigger

A trigger block as defined below.

Action WindowsWebAppSiteConfigAutoHealSettingAction

An action block as defined above.

Trigger WindowsWebAppSiteConfigAutoHealSettingTrigger

A trigger block as defined below.

action WindowsWebAppSiteConfigAutoHealSettingAction

An action block as defined above.

trigger WindowsWebAppSiteConfigAutoHealSettingTrigger

A trigger block as defined below.

action WindowsWebAppSiteConfigAutoHealSettingAction

An action block as defined above.

trigger WindowsWebAppSiteConfigAutoHealSettingTrigger

A trigger block as defined below.

action WindowsWebAppSiteConfigAutoHealSettingAction

An action block as defined above.

trigger WindowsWebAppSiteConfigAutoHealSettingTrigger

A trigger block as defined below.

action Property Map

An action block as defined above.

trigger Property Map

A trigger block as defined below.

WindowsWebAppSiteConfigAutoHealSettingAction

ActionType string

Predefined action to be taken to an Auto Heal trigger. Possible values include: Recycle, LogEvent, and CustomAction.

CustomAction WindowsWebAppSiteConfigAutoHealSettingActionCustomAction

A custom_action block as defined below.

MinimumProcessExecutionTime string

The minimum amount of time in hh:mm:ss the Windows Web App must have been running before the defined action will be run in the event of a trigger.

ActionType string

Predefined action to be taken to an Auto Heal trigger. Possible values include: Recycle, LogEvent, and CustomAction.

CustomAction WindowsWebAppSiteConfigAutoHealSettingActionCustomAction

A custom_action block as defined below.

MinimumProcessExecutionTime string

The minimum amount of time in hh:mm:ss the Windows Web App must have been running before the defined action will be run in the event of a trigger.

actionType String

Predefined action to be taken to an Auto Heal trigger. Possible values include: Recycle, LogEvent, and CustomAction.

customAction WindowsWebAppSiteConfigAutoHealSettingActionCustomAction

A custom_action block as defined below.

minimumProcessExecutionTime String

The minimum amount of time in hh:mm:ss the Windows Web App must have been running before the defined action will be run in the event of a trigger.

actionType string

Predefined action to be taken to an Auto Heal trigger. Possible values include: Recycle, LogEvent, and CustomAction.

customAction WindowsWebAppSiteConfigAutoHealSettingActionCustomAction

A custom_action block as defined below.

minimumProcessExecutionTime string

The minimum amount of time in hh:mm:ss the Windows Web App must have been running before the defined action will be run in the event of a trigger.

action_type str

Predefined action to be taken to an Auto Heal trigger. Possible values include: Recycle, LogEvent, and CustomAction.

custom_action WindowsWebAppSiteConfigAutoHealSettingActionCustomAction

A custom_action block as defined below.

minimum_process_execution_time str

The minimum amount of time in hh:mm:ss the Windows Web App must have been running before the defined action will be run in the event of a trigger.

actionType String

Predefined action to be taken to an Auto Heal trigger. Possible values include: Recycle, LogEvent, and CustomAction.

customAction Property Map

A custom_action block as defined below.

minimumProcessExecutionTime String

The minimum amount of time in hh:mm:ss the Windows Web App must have been running before the defined action will be run in the event of a trigger.

WindowsWebAppSiteConfigAutoHealSettingActionCustomAction

Executable string

The executable to run for the custom_action.

Parameters string

The parameters to pass to the specified executable.

Executable string

The executable to run for the custom_action.

Parameters string

The parameters to pass to the specified executable.

executable String

The executable to run for the custom_action.

parameters String

The parameters to pass to the specified executable.

executable string

The executable to run for the custom_action.

parameters string

The parameters to pass to the specified executable.

executable str

The executable to run for the custom_action.

parameters str

The parameters to pass to the specified executable.

executable String

The executable to run for the custom_action.

parameters String

The parameters to pass to the specified executable.

WindowsWebAppSiteConfigAutoHealSettingTrigger

PrivateMemoryKb int

The amount of Private Memory to be consumed for this rule to trigger. Possible values are between 102400 and 13631488.

Requests WindowsWebAppSiteConfigAutoHealSettingTriggerRequests

A requests block as defined above.

SlowRequests List<WindowsWebAppSiteConfigAutoHealSettingTriggerSlowRequest>

One or more slow_request blocks as defined above.

StatusCodes List<WindowsWebAppSiteConfigAutoHealSettingTriggerStatusCode>

One or more status_code blocks as defined above.

PrivateMemoryKb int

The amount of Private Memory to be consumed for this rule to trigger. Possible values are between 102400 and 13631488.

Requests WindowsWebAppSiteConfigAutoHealSettingTriggerRequests

A requests block as defined above.

SlowRequests []WindowsWebAppSiteConfigAutoHealSettingTriggerSlowRequest

One or more slow_request blocks as defined above.

StatusCodes []WindowsWebAppSiteConfigAutoHealSettingTriggerStatusCode

One or more status_code blocks as defined above.

privateMemoryKb Integer

The amount of Private Memory to be consumed for this rule to trigger. Possible values are between 102400 and 13631488.

requests WindowsWebAppSiteConfigAutoHealSettingTriggerRequests

A requests block as defined above.

slowRequests List<WindowsWebAppSiteConfigAutoHealSettingTriggerSlowRequest>

One or more slow_request blocks as defined above.

statusCodes List<WindowsWebAppSiteConfigAutoHealSettingTriggerStatusCode>

One or more status_code blocks as defined above.

privateMemoryKb number

The amount of Private Memory to be consumed for this rule to trigger. Possible values are between 102400 and 13631488.

requests WindowsWebAppSiteConfigAutoHealSettingTriggerRequests

A requests block as defined above.

slowRequests WindowsWebAppSiteConfigAutoHealSettingTriggerSlowRequest[]

One or more slow_request blocks as defined above.

statusCodes WindowsWebAppSiteConfigAutoHealSettingTriggerStatusCode[]

One or more status_code blocks as defined above.

private_memory_kb int

The amount of Private Memory to be consumed for this rule to trigger. Possible values are between 102400 and 13631488.

requests WindowsWebAppSiteConfigAutoHealSettingTriggerRequests

A requests block as defined above.

slow_requests Sequence[WindowsWebAppSiteConfigAutoHealSettingTriggerSlowRequest]

One or more slow_request blocks as defined above.

status_codes Sequence[WindowsWebAppSiteConfigAutoHealSettingTriggerStatusCode]

One or more status_code blocks as defined above.

privateMemoryKb Number

The amount of Private Memory to be consumed for this rule to trigger. Possible values are between 102400 and 13631488.

requests Property Map

A requests block as defined above.

slowRequests List<Property Map>

One or more slow_request blocks as defined above.

statusCodes List<Property Map>

One or more status_code blocks as defined above.

WindowsWebAppSiteConfigAutoHealSettingTriggerRequests

Count int

The number of requests in the specified interval to trigger this rule.

Interval string

The interval in hh:mm:ss.

Count int

The number of requests in the specified interval to trigger this rule.

Interval string

The interval in hh:mm:ss.

count Integer

The number of requests in the specified interval to trigger this rule.

interval String

The interval in hh:mm:ss.

count number

The number of requests in the specified interval to trigger this rule.

interval string

The interval in hh:mm:ss.

count int

The number of requests in the specified interval to trigger this rule.

interval str

The interval in hh:mm:ss.

count Number

The number of requests in the specified interval to trigger this rule.

interval String

The interval in hh:mm:ss.

WindowsWebAppSiteConfigAutoHealSettingTriggerSlowRequest

Count int

The number of Slow Requests in the time interval to trigger this rule.

Interval string

The time interval in the form hh:mm:ss.

TimeTaken string

The threshold of time passed to qualify as a Slow Request in hh:mm:ss.

Path string

The path for which this slow request rule applies.

Count int

The number of Slow Requests in the time interval to trigger this rule.

Interval string

The time interval in the form hh:mm:ss.

TimeTaken string

The threshold of time passed to qualify as a Slow Request in hh:mm:ss.

Path string

The path for which this slow request rule applies.

count Integer

The number of Slow Requests in the time interval to trigger this rule.

interval String

The time interval in the form hh:mm:ss.

timeTaken String

The threshold of time passed to qualify as a Slow Request in hh:mm:ss.

path String

The path for which this slow request rule applies.

count number

The number of Slow Requests in the time interval to trigger this rule.

interval string

The time interval in the form hh:mm:ss.

timeTaken string

The threshold of time passed to qualify as a Slow Request in hh:mm:ss.

path string

The path for which this slow request rule applies.

count int

The number of Slow Requests in the time interval to trigger this rule.

interval str

The time interval in the form hh:mm:ss.

time_taken str

The threshold of time passed to qualify as a Slow Request in hh:mm:ss.

path str

The path for which this slow request rule applies.

count Number

The number of Slow Requests in the time interval to trigger this rule.

interval String

The time interval in the form hh:mm:ss.

timeTaken String

The threshold of time passed to qualify as a Slow Request in hh:mm:ss.

path String

The path for which this slow request rule applies.

WindowsWebAppSiteConfigAutoHealSettingTriggerStatusCode

Count int

The number of occurrences of the defined status_code in the specified interval on which to trigger this rule.

Interval string

The time interval in the form hh:mm:ss.

StatusCodeRange string

The status code for this rule, accepts single status codes and status code ranges. e.g. 500 or 400-499. Possible values are integers between 101 and 599

Path string

The path to which this rule status code applies.

SubStatus int

The Request Sub Status of the Status Code.

Win32Status string

The Win32 Status Code of the Request.

Count int

The number of occurrences of the defined status_code in the specified interval on which to trigger this rule.

Interval string

The time interval in the form hh:mm:ss.

StatusCodeRange string

The status code for this rule, accepts single status codes and status code ranges. e.g. 500 or 400-499. Possible values are integers between 101 and 599

Path string

The path to which this rule status code applies.

SubStatus int

The Request Sub Status of the Status Code.

Win32Status string

The Win32 Status Code of the Request.

count Integer

The number of occurrences of the defined status_code in the specified interval on which to trigger this rule.

interval String

The time interval in the form hh:mm:ss.

statusCodeRange String

The status code for this rule, accepts single status codes and status code ranges. e.g. 500 or 400-499. Possible values are integers between 101 and 599

path String

The path to which this rule status code applies.

subStatus Integer

The Request Sub Status of the Status Code.

win32Status String

The Win32 Status Code of the Request.

count number

The number of occurrences of the defined status_code in the specified interval on which to trigger this rule.

interval string

The time interval in the form hh:mm:ss.

statusCodeRange string

The status code for this rule, accepts single status codes and status code ranges. e.g. 500 or 400-499. Possible values are integers between 101 and 599

path string

The path to which this rule status code applies.

subStatus number

The Request Sub Status of the Status Code.

win32Status string

The Win32 Status Code of the Request.

count int

The number of occurrences of the defined status_code in the specified interval on which to trigger this rule.

interval str

The time interval in the form hh:mm:ss.

status_code_range str

The status code for this rule, accepts single status codes and status code ranges. e.g. 500 or 400-499. Possible values are integers between 101 and 599

path str

The path to which this rule status code applies.

sub_status int

The Request Sub Status of the Status Code.

win32_status str

The Win32 Status Code of the Request.

count Number

The number of occurrences of the defined status_code in the specified interval on which to trigger this rule.

interval String

The time interval in the form hh:mm:ss.

statusCodeRange String

The status code for this rule, accepts single status codes and status code ranges. e.g. 500 or 400-499. Possible values are integers between 101 and 599

path String

The path to which this rule status code applies.

subStatus Number

The Request Sub Status of the Status Code.

win32Status String

The Win32 Status Code of the Request.

WindowsWebAppSiteConfigCors

AllowedOrigins List<string>

Specifies a list of origins that should be allowed to make cross-origin calls.

SupportCredentials bool

Whether CORS requests with credentials are allowed. Defaults to false

AllowedOrigins []string

Specifies a list of origins that should be allowed to make cross-origin calls.

SupportCredentials bool

Whether CORS requests with credentials are allowed. Defaults to false

allowedOrigins List<String>

Specifies a list of origins that should be allowed to make cross-origin calls.

supportCredentials Boolean

Whether CORS requests with credentials are allowed. Defaults to false

allowedOrigins string[]

Specifies a list of origins that should be allowed to make cross-origin calls.

supportCredentials boolean

Whether CORS requests with credentials are allowed. Defaults to false

allowed_origins Sequence[str]

Specifies a list of origins that should be allowed to make cross-origin calls.

support_credentials bool

Whether CORS requests with credentials are allowed. Defaults to false

allowedOrigins List<String>

Specifies a list of origins that should be allowed to make cross-origin calls.

supportCredentials Boolean

Whether CORS requests with credentials are allowed. Defaults to false

WindowsWebAppSiteConfigIpRestriction

Action string

The action to take. Possible values are Allow or Deny.

Headers WindowsWebAppSiteConfigIpRestrictionHeaders

A headers block as defined above.

IpAddress string

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

Name string

The name which should be used for this ip_restriction.

Priority int

The priority value of this ip_restriction. Defaults to 65000.

ServiceTag string

The Service Tag used for this IP Restriction.

VirtualNetworkSubnetId string

The Virtual Network Subnet ID used for this IP Restriction.

Action string

The action to take. Possible values are Allow or Deny.

Headers WindowsWebAppSiteConfigIpRestrictionHeaders

A headers block as defined above.

IpAddress string

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

Name string

The name which should be used for this ip_restriction.

Priority int

The priority value of this ip_restriction. Defaults to 65000.

ServiceTag string

The Service Tag used for this IP Restriction.

VirtualNetworkSubnetId string

The Virtual Network Subnet ID used for this IP Restriction.

action String

The action to take. Possible values are Allow or Deny.

headers WindowsWebAppSiteConfigIpRestrictionHeaders

A headers block as defined above.

ipAddress String

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

name String

The name which should be used for this ip_restriction.

priority Integer

The priority value of this ip_restriction. Defaults to 65000.

serviceTag String

The Service Tag used for this IP Restriction.

virtualNetworkSubnetId String

The Virtual Network Subnet ID used for this IP Restriction.

action string

The action to take. Possible values are Allow or Deny.

headers WindowsWebAppSiteConfigIpRestrictionHeaders

A headers block as defined above.

ipAddress string

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

name string

The name which should be used for this ip_restriction.

priority number

The priority value of this ip_restriction. Defaults to 65000.

serviceTag string

The Service Tag used for this IP Restriction.

virtualNetworkSubnetId string

The Virtual Network Subnet ID used for this IP Restriction.

action str

The action to take. Possible values are Allow or Deny.

headers WindowsWebAppSiteConfigIpRestrictionHeaders

A headers block as defined above.

ip_address str

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

name str

The name which should be used for this ip_restriction.

priority int

The priority value of this ip_restriction. Defaults to 65000.

service_tag str

The Service Tag used for this IP Restriction.

virtual_network_subnet_id str

The Virtual Network Subnet ID used for this IP Restriction.

action String

The action to take. Possible values are Allow or Deny.

headers Property Map

A headers block as defined above.

ipAddress String

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

name String

The name which should be used for this ip_restriction.

priority Number

The priority value of this ip_restriction. Defaults to 65000.

serviceTag String

The Service Tag used for this IP Restriction.

virtualNetworkSubnetId String

The Virtual Network Subnet ID used for this IP Restriction.

WindowsWebAppSiteConfigIpRestrictionHeaders

XAzureFdids List<string>

Specifies a list of Azure Front Door IDs.

XFdHealthProbe string

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

XForwardedFors List<string>

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

XForwardedHosts List<string>

Specifies a list of Hosts for which matching should be applied.

XAzureFdids []string

Specifies a list of Azure Front Door IDs.

XFdHealthProbe string

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

XForwardedFors []string

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

XForwardedHosts []string

Specifies a list of Hosts for which matching should be applied.

xAzureFdids List<String>

Specifies a list of Azure Front Door IDs.

xFdHealthProbe String

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

xForwardedFors List<String>

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

xForwardedHosts List<String>

Specifies a list of Hosts for which matching should be applied.

xAzureFdids string[]

Specifies a list of Azure Front Door IDs.

xFdHealthProbe string

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

xForwardedFors string[]

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

xForwardedHosts string[]

Specifies a list of Hosts for which matching should be applied.

x_azure_fdids Sequence[str]

Specifies a list of Azure Front Door IDs.

x_fd_health_probe str

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

x_forwarded_fors Sequence[str]

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

x_forwarded_hosts Sequence[str]

Specifies a list of Hosts for which matching should be applied.

xAzureFdids List<String>

Specifies a list of Azure Front Door IDs.

xFdHealthProbe String

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

xForwardedFors List<String>

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

xForwardedHosts List<String>

Specifies a list of Hosts for which matching should be applied.

WindowsWebAppSiteConfigScmIpRestriction

Action string

The action to take. Possible values are Allow or Deny.

Headers WindowsWebAppSiteConfigScmIpRestrictionHeaders

A headers block as defined above.

IpAddress string

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

Name string

The name which should be used for this ip_restriction.

Priority int

The priority value of this ip_restriction. Defaults to 65000.

ServiceTag string

The Service Tag used for this IP Restriction.

VirtualNetworkSubnetId string

The Virtual Network Subnet ID used for this IP Restriction.

Action string

The action to take. Possible values are Allow or Deny.

Headers WindowsWebAppSiteConfigScmIpRestrictionHeaders

A headers block as defined above.

IpAddress string

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

Name string

The name which should be used for this ip_restriction.

Priority int

The priority value of this ip_restriction. Defaults to 65000.

ServiceTag string

The Service Tag used for this IP Restriction.

VirtualNetworkSubnetId string

The Virtual Network Subnet ID used for this IP Restriction.

action String

The action to take. Possible values are Allow or Deny.

headers WindowsWebAppSiteConfigScmIpRestrictionHeaders

A headers block as defined above.

ipAddress String

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

name String

The name which should be used for this ip_restriction.

priority Integer

The priority value of this ip_restriction. Defaults to 65000.

serviceTag String

The Service Tag used for this IP Restriction.

virtualNetworkSubnetId String

The Virtual Network Subnet ID used for this IP Restriction.

action string

The action to take. Possible values are Allow or Deny.

headers WindowsWebAppSiteConfigScmIpRestrictionHeaders

A headers block as defined above.

ipAddress string

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

name string

The name which should be used for this ip_restriction.

priority number

The priority value of this ip_restriction. Defaults to 65000.

serviceTag string

The Service Tag used for this IP Restriction.

virtualNetworkSubnetId string

The Virtual Network Subnet ID used for this IP Restriction.

action str

The action to take. Possible values are Allow or Deny.

headers WindowsWebAppSiteConfigScmIpRestrictionHeaders

A headers block as defined above.

ip_address str

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

name str

The name which should be used for this ip_restriction.

priority int

The priority value of this ip_restriction. Defaults to 65000.

service_tag str

The Service Tag used for this IP Restriction.

virtual_network_subnet_id str

The Virtual Network Subnet ID used for this IP Restriction.

action String

The action to take. Possible values are Allow or Deny.

headers Property Map

A headers block as defined above.

ipAddress String

The CIDR notation of the IP or IP Range to match. For example: 10.0.0.0/24 or 192.168.10.1/32

name String

The name which should be used for this ip_restriction.

priority Number

The priority value of this ip_restriction. Defaults to 65000.

serviceTag String

The Service Tag used for this IP Restriction.

virtualNetworkSubnetId String

The Virtual Network Subnet ID used for this IP Restriction.

WindowsWebAppSiteConfigScmIpRestrictionHeaders

XAzureFdids List<string>

Specifies a list of Azure Front Door IDs.

XFdHealthProbe string

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

XForwardedFors List<string>

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

XForwardedHosts List<string>

Specifies a list of Hosts for which matching should be applied.

XAzureFdids []string

Specifies a list of Azure Front Door IDs.

XFdHealthProbe string

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

XForwardedFors []string

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

XForwardedHosts []string

Specifies a list of Hosts for which matching should be applied.

xAzureFdids List<String>

Specifies a list of Azure Front Door IDs.

xFdHealthProbe String

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

xForwardedFors List<String>

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

xForwardedHosts List<String>

Specifies a list of Hosts for which matching should be applied.

xAzureFdids string[]

Specifies a list of Azure Front Door IDs.

xFdHealthProbe string

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

xForwardedFors string[]

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

xForwardedHosts string[]

Specifies a list of Hosts for which matching should be applied.

x_azure_fdids Sequence[str]

Specifies a list of Azure Front Door IDs.

x_fd_health_probe str

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

x_forwarded_fors Sequence[str]

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

x_forwarded_hosts Sequence[str]

Specifies a list of Hosts for which matching should be applied.

xAzureFdids List<String>

Specifies a list of Azure Front Door IDs.

xFdHealthProbe String

Specifies if a Front Door Health Probe should be expected. The only possible value is 1.

xForwardedFors List<String>

Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.

xForwardedHosts List<String>

Specifies a list of Hosts for which matching should be applied.

WindowsWebAppSiteConfigVirtualApplication

PhysicalPath string

The physical path for the Virtual Application.

Preload bool

Should pre-loading be enabled.

VirtualPath string

The Virtual Path for the Virtual Application.

VirtualDirectories List<WindowsWebAppSiteConfigVirtualApplicationVirtualDirectory>

One or more virtual_directory blocks as defined below.

PhysicalPath string

The physical path for the Virtual Application.

Preload bool

Should pre-loading be enabled.

VirtualPath string

The Virtual Path for the Virtual Application.

VirtualDirectories []WindowsWebAppSiteConfigVirtualApplicationVirtualDirectory

One or more virtual_directory blocks as defined below.

physicalPath String

The physical path for the Virtual Application.

preload Boolean

Should pre-loading be enabled.

virtualPath String

The Virtual Path for the Virtual Application.

virtualDirectories List<WindowsWebAppSiteConfigVirtualApplicationVirtualDirectory>

One or more virtual_directory blocks as defined below.

physicalPath string

The physical path for the Virtual Application.

preload boolean

Should pre-loading be enabled.

virtualPath string

The Virtual Path for the Virtual Application.

virtualDirectories WindowsWebAppSiteConfigVirtualApplicationVirtualDirectory[]

One or more virtual_directory blocks as defined below.

physical_path str

The physical path for the Virtual Application.

preload bool

Should pre-loading be enabled.

virtual_path str

The Virtual Path for the Virtual Application.

virtual_directories Sequence[WindowsWebAppSiteConfigVirtualApplicationVirtualDirectory]

One or more virtual_directory blocks as defined below.

physicalPath String

The physical path for the Virtual Application.

preload Boolean

Should pre-loading be enabled.

virtualPath String

The Virtual Path for the Virtual Application.

virtualDirectories List<Property Map>

One or more virtual_directory blocks as defined below.

WindowsWebAppSiteConfigVirtualApplicationVirtualDirectory

PhysicalPath string

The physical path for the Virtual Application.

VirtualPath string

The Virtual Path for the Virtual Application.

PhysicalPath string

The physical path for the Virtual Application.

VirtualPath string

The Virtual Path for the Virtual Application.

physicalPath String

The physical path for the Virtual Application.

virtualPath String

The Virtual Path for the Virtual Application.

physicalPath string

The physical path for the Virtual Application.

virtualPath string

The Virtual Path for the Virtual Application.

physical_path str

The physical path for the Virtual Application.

virtual_path str

The Virtual Path for the Virtual Application.

physicalPath String

The physical path for the Virtual Application.

virtualPath String

The Virtual Path for the Virtual Application.

WindowsWebAppSiteCredential

Name string

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

Password string

The Site Credentials Password used for publishing.

Name string

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

Password string

The Site Credentials Password used for publishing.

name String

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

password String

The Site Credentials Password used for publishing.

name string

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

password string

The Site Credentials Password used for publishing.

name str

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

password str

The Site Credentials Password used for publishing.

name String

The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created.

password String

The Site Credentials Password used for publishing.

WindowsWebAppStickySettings

AppSettingNames List<string>

A list of app_setting names that the Windows Web App will not swap between Slots when a swap operation is triggered.

ConnectionStringNames List<string>

A list of connection_string names that the Windows Web App will not swap between Slots when a swap operation is triggered.

AppSettingNames []string

A list of app_setting names that the Windows Web App will not swap between Slots when a swap operation is triggered.

ConnectionStringNames []string

A list of connection_string names that the Windows Web App will not swap between Slots when a swap operation is triggered.

appSettingNames List<String>

A list of app_setting names that the Windows Web App will not swap between Slots when a swap operation is triggered.

connectionStringNames List<String>

A list of connection_string names that the Windows Web App will not swap between Slots when a swap operation is triggered.

appSettingNames string[]

A list of app_setting names that the Windows Web App will not swap between Slots when a swap operation is triggered.

connectionStringNames string[]

A list of connection_string names that the Windows Web App will not swap between Slots when a swap operation is triggered.

app_setting_names Sequence[str]

A list of app_setting names that the Windows Web App will not swap between Slots when a swap operation is triggered.

connection_string_names Sequence[str]

A list of connection_string names that the Windows Web App will not swap between Slots when a swap operation is triggered.

appSettingNames List<String>

A list of app_setting names that the Windows Web App will not swap between Slots when a swap operation is triggered.

connectionStringNames List<String>

A list of connection_string names that the Windows Web App will not swap between Slots when a swap operation is triggered.

WindowsWebAppStorageAccount

AccessKey string

The Access key for the storage account.

AccountName string

The Name of the Storage Account.

Name string

The name which should be used for this TODO.

ShareName string

The Name of the File Share or Container Name for Blob storage.

Type string

The Azure Storage Type. Possible values include AzureFiles and AzureBlob

MountPath string

The path at which to mount the storage share.

AccessKey string

The Access key for the storage account.

AccountName string

The Name of the Storage Account.

Name string

The name which should be used for this TODO.

ShareName string

The Name of the File Share or Container Name for Blob storage.

Type string

The Azure Storage Type. Possible values include AzureFiles and AzureBlob

MountPath string

The path at which to mount the storage share.

accessKey String

The Access key for the storage account.

accountName String

The Name of the Storage Account.

name String

The name which should be used for this TODO.

shareName String

The Name of the File Share or Container Name for Blob storage.

type String

The Azure Storage Type. Possible values include AzureFiles and AzureBlob

mountPath String

The path at which to mount the storage share.

accessKey string

The Access key for the storage account.

accountName string

The Name of the Storage Account.

name string

The name which should be used for this TODO.

shareName string

The Name of the File Share or Container Name for Blob storage.

type string

The Azure Storage Type. Possible values include AzureFiles and AzureBlob

mountPath string

The path at which to mount the storage share.

access_key str

The Access key for the storage account.

account_name str

The Name of the Storage Account.

name str

The name which should be used for this TODO.

share_name str

The Name of the File Share or Container Name for Blob storage.

type str

The Azure Storage Type. Possible values include AzureFiles and AzureBlob

mount_path str

The path at which to mount the storage share.

accessKey String

The Access key for the storage account.

accountName String

The Name of the Storage Account.

name String

The name which should be used for this TODO.

shareName String

The Name of the File Share or Container Name for Blob storage.

type String

The Azure Storage Type. Possible values include AzureFiles and AzureBlob

mountPath String

The path at which to mount the storage share.

Import

Windows Web Apps can be imported using the resource id, e.g.

 $ pulumi import azure:appservice/windowsWebApp:WindowsWebApp example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.Web/sites/site1

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.