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:
- Resource
Group stringName 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 stringId The ID of the Service Plan that this Windows App Service will be created in.
- Site
Config WindowsWeb App Site Config Args A
site_config
block as defined below.- App
Settings Dictionary<string, string> A map of key-value pairs of App Settings.
- Auth
Settings WindowsWeb App Auth Settings Args An
auth_settings
block as defined below.- Auth
Settings WindowsV2 Web App Auth Settings V2Args An
auth_settings_v2
block as defined below.- Backup
Windows
Web App Backup Args A
backup
block as defined below.- Client
Affinity boolEnabled Should Client Affinity be enabled?
- Client
Certificate boolEnabled Should Client Certificates be enabled?
- Client
Certificate stringExclusion Paths Paths to exclude when using client certificates, separated by ;
- Client
Certificate stringMode The Client Certificate mode. Possible values are
Required
,Optional
, andOptionalInteractiveUser
. This property has no effect whenclient_cert_enabled
isfalse
- Connection
Strings List<WindowsWeb App Connection String Args> 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
Windows
Web App Identity Args An
identity
block as defined below.- Key
Vault stringReference Identity Id The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
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
Windows
Web App Logs Args 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.
- Sticky
Settings WindowsWeb App Sticky Settings Args A
sticky_settings
block as defined below.- Storage
Accounts List<WindowsWeb App Storage Account Args> One or more
storage_account
blocks as defined below.- Dictionary<string, string>
A mapping of tags which should be assigned to the Windows Web App.
- Virtual
Network stringSubnet Id The subnet id which will be used by this Web App for regional virtual network integration.
- Zip
Deploy stringFile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
- Resource
Group stringName 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 stringId The ID of the Service Plan that this Windows App Service will be created in.
- Site
Config WindowsWeb App Site Config Args A
site_config
block as defined below.- App
Settings map[string]string A map of key-value pairs of App Settings.
- Auth
Settings WindowsWeb App Auth Settings Args An
auth_settings
block as defined below.- Auth
Settings WindowsV2 Web App Auth Settings V2Args An
auth_settings_v2
block as defined below.- Backup
Windows
Web App Backup Args A
backup
block as defined below.- Client
Affinity boolEnabled Should Client Affinity be enabled?
- Client
Certificate boolEnabled Should Client Certificates be enabled?
- Client
Certificate stringExclusion Paths Paths to exclude when using client certificates, separated by ;
- Client
Certificate stringMode The Client Certificate mode. Possible values are
Required
,Optional
, andOptionalInteractiveUser
. This property has no effect whenclient_cert_enabled
isfalse
- Connection
Strings []WindowsWeb App Connection String Args 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
Windows
Web App Identity Args An
identity
block as defined below.- Key
Vault stringReference Identity Id The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
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
Windows
Web App Logs Args 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.
- Sticky
Settings WindowsWeb App Sticky Settings Args A
sticky_settings
block as defined below.- Storage
Accounts []WindowsWeb App Storage Account Args One or more
storage_account
blocks as defined below.- map[string]string
A mapping of tags which should be assigned to the Windows Web App.
- Virtual
Network stringSubnet Id The subnet id which will be used by this Web App for regional virtual network integration.
- Zip
Deploy stringFile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
- resource
Group StringName 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 StringId The ID of the Service Plan that this Windows App Service will be created in.
- site
Config WindowsWeb App Site Config Args A
site_config
block as defined below.- app
Settings Map<String,String> A map of key-value pairs of App Settings.
- auth
Settings WindowsWeb App Auth Settings Args An
auth_settings
block as defined below.- auth
Settings WindowsV2 Web App Auth Settings V2Args An
auth_settings_v2
block as defined below.- backup
Windows
Web App Backup Args A
backup
block as defined below.- client
Affinity BooleanEnabled Should Client Affinity be enabled?
- client
Certificate BooleanEnabled Should Client Certificates be enabled?
- client
Certificate StringExclusion Paths Paths to exclude when using client certificates, separated by ;
- client
Certificate StringMode The Client Certificate mode. Possible values are
Required
,Optional
, andOptionalInteractiveUser
. This property has no effect whenclient_cert_enabled
isfalse
- connection
Strings List<WindowsWeb App Connection String Args> One or more
connection_string
blocks as defined below.- enabled Boolean
Should the Windows Web App be enabled? Defaults to
true
.- https
Only Boolean Should the Windows Web App require HTTPS connections.
- identity
Windows
Web App Identity Args An
identity
block as defined below.- key
Vault StringReference Identity Id The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
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
Windows
Web App Logs Args 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.
- sticky
Settings WindowsWeb App Sticky Settings Args A
sticky_settings
block as defined below.- storage
Accounts List<WindowsWeb App Storage Account Args> One or more
storage_account
blocks as defined below.- Map<String,String>
A mapping of tags which should be assigned to the Windows Web App.
- virtual
Network StringSubnet Id The subnet id which will be used by this Web App for regional virtual network integration.
- zip
Deploy StringFile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
- resource
Group stringName 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 stringId The ID of the Service Plan that this Windows App Service will be created in.
- site
Config WindowsWeb App Site Config Args A
site_config
block as defined below.- app
Settings {[key: string]: string} A map of key-value pairs of App Settings.
- auth
Settings WindowsWeb App Auth Settings Args An
auth_settings
block as defined below.- auth
Settings WindowsV2 Web App Auth Settings V2Args An
auth_settings_v2
block as defined below.- backup
Windows
Web App Backup Args A
backup
block as defined below.- client
Affinity booleanEnabled Should Client Affinity be enabled?
- client
Certificate booleanEnabled Should Client Certificates be enabled?
- client
Certificate stringExclusion Paths Paths to exclude when using client certificates, separated by ;
- client
Certificate stringMode The Client Certificate mode. Possible values are
Required
,Optional
, andOptionalInteractiveUser
. This property has no effect whenclient_cert_enabled
isfalse
- connection
Strings WindowsWeb App Connection String Args[] One or more
connection_string
blocks as defined below.- enabled boolean
Should the Windows Web App be enabled? Defaults to
true
.- https
Only boolean Should the Windows Web App require HTTPS connections.
- identity
Windows
Web App Identity Args An
identity
block as defined below.- key
Vault stringReference Identity Id The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
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
Windows
Web App Logs Args 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.
- sticky
Settings WindowsWeb App Sticky Settings Args A
sticky_settings
block as defined below.- storage
Accounts WindowsWeb App Storage Account Args[] One or more
storage_account
blocks as defined below.- {[key: string]: string}
A mapping of tags which should be assigned to the Windows Web App.
- virtual
Network stringSubnet Id The subnet id which will be used by this Web App for regional virtual network integration.
- zip
Deploy stringFile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
- resource_
group_ strname 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_ strid The ID of the Service Plan that this Windows App Service will be created in.
- site_
config WindowsWeb App Site Config Args A
site_config
block as defined below.- app_
settings Mapping[str, str] A map of key-value pairs of App Settings.
- auth_
settings WindowsWeb App Auth Settings Args An
auth_settings
block as defined below.- auth_
settings_ Windowsv2 Web App Auth Settings V2Args An
auth_settings_v2
block as defined below.- backup
Windows
Web App Backup Args A
backup
block as defined below.- client_
affinity_ boolenabled Should Client Affinity be enabled?
- client_
certificate_ boolenabled Should Client Certificates be enabled?
- client_
certificate_ strexclusion_ paths Paths to exclude when using client certificates, separated by ;
- client_
certificate_ strmode The Client Certificate mode. Possible values are
Required
,Optional
, andOptionalInteractiveUser
. This property has no effect whenclient_cert_enabled
isfalse
- connection_
strings Sequence[WindowsWeb App Connection String Args] 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
Windows
Web App Identity Args An
identity
block as defined below.- key_
vault_ strreference_ identity_ id The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
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
Windows
Web App Logs Args 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 WindowsWeb App Sticky Settings Args A
sticky_settings
block as defined below.- storage_
accounts Sequence[WindowsWeb App Storage Account Args] One or more
storage_account
blocks as defined below.- Mapping[str, str]
A mapping of tags which should be assigned to the Windows Web App.
- virtual_
network_ strsubnet_ id The subnet id which will be used by this Web App for regional virtual network integration.
- zip_
deploy_ strfile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
- resource
Group StringName 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 StringId The ID of the Service Plan that this Windows App Service will be created in.
- site
Config Property Map A
site_config
block as defined below.- app
Settings Map<String> A map of key-value pairs of App Settings.
- auth
Settings Property Map An
auth_settings
block as defined below.- auth
Settings Property MapV2 An
auth_settings_v2
block as defined below.- backup Property Map
A
backup
block as defined below.- client
Affinity BooleanEnabled Should Client Affinity be enabled?
- client
Certificate BooleanEnabled Should Client Certificates be enabled?
- client
Certificate StringExclusion Paths Paths to exclude when using client certificates, separated by ;
- client
Certificate StringMode The Client Certificate mode. Possible values are
Required
,Optional
, andOptionalInteractiveUser
. This property has no effect whenclient_cert_enabled
isfalse
- connection
Strings List<Property Map> One or more
connection_string
blocks as defined below.- enabled Boolean
Should the Windows Web App be enabled? Defaults to
true
.- https
Only Boolean Should the Windows Web App require HTTPS connections.
- identity Property Map
An
identity
block as defined below.- key
Vault StringReference Identity Id The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
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.
- sticky
Settings Property Map A
sticky_settings
block as defined below.- storage
Accounts List<Property Map> One or more
storage_account
blocks as defined below.- Map<String>
A mapping of tags which should be assigned to the Windows Web App.
- virtual
Network StringSubnet Id The subnet id which will be used by this Web App for regional virtual network integration.
- zip
Deploy StringFile 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:
- Custom
Domain stringVerification Id The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- Default
Hostname string The default hostname of the Windows Web App.
- Id string
The provider-assigned unique ID for this managed resource.
- Kind string
The Kind value for this Windows Web App.
- Outbound
Ip List<string>Address Lists A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- Outbound
Ip stringAddresses A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
.- Possible
Outbound List<string>Ip Address Lists A
possible_outbound_ip_address_list
block as defined below.- Possible
Outbound stringIp Addresses 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 ofoutbound_ip_addresses
.- Site
Credentials List<WindowsWeb App Site Credential> A
site_credential
block as defined below.
- Custom
Domain stringVerification Id The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- Default
Hostname string The default hostname of the Windows Web App.
- Id string
The provider-assigned unique ID for this managed resource.
- Kind string
The Kind value for this Windows Web App.
- Outbound
Ip []stringAddress Lists A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- Outbound
Ip stringAddresses A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
.- Possible
Outbound []stringIp Address Lists A
possible_outbound_ip_address_list
block as defined below.- Possible
Outbound stringIp Addresses 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 ofoutbound_ip_addresses
.- Site
Credentials []WindowsWeb App Site Credential A
site_credential
block as defined below.
- custom
Domain StringVerification Id The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Hostname String The default hostname of the Windows Web App.
- id String
The provider-assigned unique ID for this managed resource.
- kind String
The Kind value for this Windows Web App.
- outbound
Ip List<String>Address Lists A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- outbound
Ip StringAddresses A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
.- possible
Outbound List<String>Ip Address Lists A
possible_outbound_ip_address_list
block as defined below.- possible
Outbound StringIp Addresses 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 ofoutbound_ip_addresses
.- site
Credentials List<WindowsWeb App Site Credential> A
site_credential
block as defined below.
- custom
Domain stringVerification Id The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Hostname string The default hostname of the Windows Web App.
- id string
The provider-assigned unique ID for this managed resource.
- kind string
The Kind value for this Windows Web App.
- outbound
Ip string[]Address Lists A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- outbound
Ip stringAddresses A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
.- possible
Outbound string[]Ip Address Lists A
possible_outbound_ip_address_list
block as defined below.- possible
Outbound stringIp Addresses 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 ofoutbound_ip_addresses
.- site
Credentials WindowsWeb App Site Credential[] A
site_credential
block as defined below.
- custom_
domain_ strverification_ id The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default_
hostname str The default hostname of the Windows 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_ Sequence[str]address_ lists A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- outbound_
ip_ straddresses A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
.- possible_
outbound_ Sequence[str]ip_ address_ lists A
possible_outbound_ip_address_list
block as defined below.- possible_
outbound_ strip_ addresses 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 ofoutbound_ip_addresses
.- site_
credentials Sequence[WindowsWeb App Site Credential] A
site_credential
block as defined below.
- custom
Domain StringVerification Id The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Hostname String The default hostname of the Windows Web App.
- id String
The provider-assigned unique ID for this managed resource.
- kind String
The Kind value for this Windows Web App.
- outbound
Ip List<String>Address Lists A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- outbound
Ip StringAddresses A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
.- possible
Outbound List<String>Ip Address Lists A
possible_outbound_ip_address_list
block as defined below.- possible
Outbound StringIp Addresses 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 ofoutbound_ip_addresses
.- site
Credentials 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.
- App
Settings Dictionary<string, string> A map of key-value pairs of App Settings.
- Auth
Settings WindowsWeb App Auth Settings Args An
auth_settings
block as defined below.- Auth
Settings WindowsV2 Web App Auth Settings V2Args An
auth_settings_v2
block as defined below.- Backup
Windows
Web App Backup Args A
backup
block as defined below.- Client
Affinity boolEnabled Should Client Affinity be enabled?
- Client
Certificate boolEnabled Should Client Certificates be enabled?
- Client
Certificate stringExclusion Paths Paths to exclude when using client certificates, separated by ;
- Client
Certificate stringMode The Client Certificate mode. Possible values are
Required
,Optional
, andOptionalInteractiveUser
. This property has no effect whenclient_cert_enabled
isfalse
- Connection
Strings List<WindowsWeb App Connection String Args> One or more
connection_string
blocks as defined below.- Custom
Domain stringVerification Id The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- Default
Hostname string The default hostname of the Windows 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
Windows
Web App Identity Args An
identity
block as defined below.- Key
Vault stringReference Identity Id The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
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
Windows
Web App Logs Args 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.
- Outbound
Ip List<string>Address Lists A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- Outbound
Ip stringAddresses A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
.- Possible
Outbound List<string>Ip Address Lists A
possible_outbound_ip_address_list
block as defined below.- Possible
Outbound stringIp Addresses 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 ofoutbound_ip_addresses
.- Resource
Group stringName 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 stringId The ID of the Service Plan that this Windows App Service will be created in.
- Site
Config WindowsWeb App Site Config Args A
site_config
block as defined below.- Site
Credentials List<WindowsWeb App Site Credential Args> A
site_credential
block as defined below.- Sticky
Settings WindowsWeb App Sticky Settings Args A
sticky_settings
block as defined below.- Storage
Accounts List<WindowsWeb App Storage Account Args> One or more
storage_account
blocks as defined below.- Dictionary<string, string>
A mapping of tags which should be assigned to the Windows Web App.
- Virtual
Network stringSubnet Id The subnet id which will be used by this Web App for regional virtual network integration.
- Zip
Deploy stringFile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
- App
Settings map[string]string A map of key-value pairs of App Settings.
- Auth
Settings WindowsWeb App Auth Settings Args An
auth_settings
block as defined below.- Auth
Settings WindowsV2 Web App Auth Settings V2Args An
auth_settings_v2
block as defined below.- Backup
Windows
Web App Backup Args A
backup
block as defined below.- Client
Affinity boolEnabled Should Client Affinity be enabled?
- Client
Certificate boolEnabled Should Client Certificates be enabled?
- Client
Certificate stringExclusion Paths Paths to exclude when using client certificates, separated by ;
- Client
Certificate stringMode The Client Certificate mode. Possible values are
Required
,Optional
, andOptionalInteractiveUser
. This property has no effect whenclient_cert_enabled
isfalse
- Connection
Strings []WindowsWeb App Connection String Args One or more
connection_string
blocks as defined below.- Custom
Domain stringVerification Id The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- Default
Hostname string The default hostname of the Windows 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
Windows
Web App Identity Args An
identity
block as defined below.- Key
Vault stringReference Identity Id The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
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
Windows
Web App Logs Args 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.
- Outbound
Ip []stringAddress Lists A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- Outbound
Ip stringAddresses A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
.- Possible
Outbound []stringIp Address Lists A
possible_outbound_ip_address_list
block as defined below.- Possible
Outbound stringIp Addresses 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 ofoutbound_ip_addresses
.- Resource
Group stringName 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 stringId The ID of the Service Plan that this Windows App Service will be created in.
- Site
Config WindowsWeb App Site Config Args A
site_config
block as defined below.- Site
Credentials []WindowsWeb App Site Credential Args A
site_credential
block as defined below.- Sticky
Settings WindowsWeb App Sticky Settings Args A
sticky_settings
block as defined below.- Storage
Accounts []WindowsWeb App Storage Account Args One or more
storage_account
blocks as defined below.- map[string]string
A mapping of tags which should be assigned to the Windows Web App.
- Virtual
Network stringSubnet Id The subnet id which will be used by this Web App for regional virtual network integration.
- Zip
Deploy stringFile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
- app
Settings Map<String,String> A map of key-value pairs of App Settings.
- auth
Settings WindowsWeb App Auth Settings Args An
auth_settings
block as defined below.- auth
Settings WindowsV2 Web App Auth Settings V2Args An
auth_settings_v2
block as defined below.- backup
Windows
Web App Backup Args A
backup
block as defined below.- client
Affinity BooleanEnabled Should Client Affinity be enabled?
- client
Certificate BooleanEnabled Should Client Certificates be enabled?
- client
Certificate StringExclusion Paths Paths to exclude when using client certificates, separated by ;
- client
Certificate StringMode The Client Certificate mode. Possible values are
Required
,Optional
, andOptionalInteractiveUser
. This property has no effect whenclient_cert_enabled
isfalse
- connection
Strings List<WindowsWeb App Connection String Args> One or more
connection_string
blocks as defined below.- custom
Domain StringVerification Id The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Hostname String The default hostname of the Windows Web App.
- enabled Boolean
Should the Windows Web App be enabled? Defaults to
true
.- https
Only Boolean Should the Windows Web App require HTTPS connections.
- identity
Windows
Web App Identity Args An
identity
block as defined below.- key
Vault StringReference Identity Id The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
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
Windows
Web App Logs Args 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.
- outbound
Ip List<String>Address Lists A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- outbound
Ip StringAddresses A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
.- possible
Outbound List<String>Ip Address Lists A
possible_outbound_ip_address_list
block as defined below.- possible
Outbound StringIp Addresses 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 ofoutbound_ip_addresses
.- resource
Group StringName 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 StringId The ID of the Service Plan that this Windows App Service will be created in.
- site
Config WindowsWeb App Site Config Args A
site_config
block as defined below.- site
Credentials List<WindowsWeb App Site Credential Args> A
site_credential
block as defined below.- sticky
Settings WindowsWeb App Sticky Settings Args A
sticky_settings
block as defined below.- storage
Accounts List<WindowsWeb App Storage Account Args> One or more
storage_account
blocks as defined below.- Map<String,String>
A mapping of tags which should be assigned to the Windows Web App.
- virtual
Network StringSubnet Id The subnet id which will be used by this Web App for regional virtual network integration.
- zip
Deploy StringFile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
- app
Settings {[key: string]: string} A map of key-value pairs of App Settings.
- auth
Settings WindowsWeb App Auth Settings Args An
auth_settings
block as defined below.- auth
Settings WindowsV2 Web App Auth Settings V2Args An
auth_settings_v2
block as defined below.- backup
Windows
Web App Backup Args A
backup
block as defined below.- client
Affinity booleanEnabled Should Client Affinity be enabled?
- client
Certificate booleanEnabled Should Client Certificates be enabled?
- client
Certificate stringExclusion Paths Paths to exclude when using client certificates, separated by ;
- client
Certificate stringMode The Client Certificate mode. Possible values are
Required
,Optional
, andOptionalInteractiveUser
. This property has no effect whenclient_cert_enabled
isfalse
- connection
Strings WindowsWeb App Connection String Args[] One or more
connection_string
blocks as defined below.- custom
Domain stringVerification Id The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Hostname string The default hostname of the Windows Web App.
- enabled boolean
Should the Windows Web App be enabled? Defaults to
true
.- https
Only boolean Should the Windows Web App require HTTPS connections.
- identity
Windows
Web App Identity Args An
identity
block as defined below.- key
Vault stringReference Identity Id The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
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
Windows
Web App Logs Args 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.
- outbound
Ip string[]Address Lists A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- outbound
Ip stringAddresses A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
.- possible
Outbound string[]Ip Address Lists A
possible_outbound_ip_address_list
block as defined below.- possible
Outbound stringIp Addresses 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 ofoutbound_ip_addresses
.- resource
Group stringName 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 stringId The ID of the Service Plan that this Windows App Service will be created in.
- site
Config WindowsWeb App Site Config Args A
site_config
block as defined below.- site
Credentials WindowsWeb App Site Credential Args[] A
site_credential
block as defined below.- sticky
Settings WindowsWeb App Sticky Settings Args A
sticky_settings
block as defined below.- storage
Accounts WindowsWeb App Storage Account Args[] One or more
storage_account
blocks as defined below.- {[key: string]: string}
A mapping of tags which should be assigned to the Windows Web App.
- virtual
Network stringSubnet Id The subnet id which will be used by this Web App for regional virtual network integration.
- zip
Deploy stringFile 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 WindowsWeb App Auth Settings Args An
auth_settings
block as defined below.- auth_
settings_ Windowsv2 Web App Auth Settings V2Args An
auth_settings_v2
block as defined below.- backup
Windows
Web App Backup Args A
backup
block as defined below.- client_
affinity_ boolenabled Should Client Affinity be enabled?
- client_
certificate_ boolenabled Should Client Certificates be enabled?
- client_
certificate_ strexclusion_ paths Paths to exclude when using client certificates, separated by ;
- client_
certificate_ strmode The Client Certificate mode. Possible values are
Required
,Optional
, andOptionalInteractiveUser
. This property has no effect whenclient_cert_enabled
isfalse
- connection_
strings Sequence[WindowsWeb App Connection String Args] One or more
connection_string
blocks as defined below.- custom_
domain_ strverification_ id The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default_
hostname str The default hostname of the Windows 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
Windows
Web App Identity Args An
identity
block as defined below.- key_
vault_ strreference_ identity_ id The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
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
Windows
Web App Logs Args 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_ Sequence[str]address_ lists A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- outbound_
ip_ straddresses A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
.- possible_
outbound_ Sequence[str]ip_ address_ lists A
possible_outbound_ip_address_list
block as defined below.- possible_
outbound_ strip_ addresses 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 ofoutbound_ip_addresses
.- resource_
group_ strname 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_ strid The ID of the Service Plan that this Windows App Service will be created in.
- site_
config WindowsWeb App Site Config Args A
site_config
block as defined below.- site_
credentials Sequence[WindowsWeb App Site Credential Args] A
site_credential
block as defined below.- sticky_
settings WindowsWeb App Sticky Settings Args A
sticky_settings
block as defined below.- storage_
accounts Sequence[WindowsWeb App Storage Account Args] One or more
storage_account
blocks as defined below.- Mapping[str, str]
A mapping of tags which should be assigned to the Windows Web App.
- virtual_
network_ strsubnet_ id The subnet id which will be used by this Web App for regional virtual network integration.
- zip_
deploy_ strfile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
- app
Settings Map<String> A map of key-value pairs of App Settings.
- auth
Settings Property Map An
auth_settings
block as defined below.- auth
Settings Property MapV2 An
auth_settings_v2
block as defined below.- backup Property Map
A
backup
block as defined below.- client
Affinity BooleanEnabled Should Client Affinity be enabled?
- client
Certificate BooleanEnabled Should Client Certificates be enabled?
- client
Certificate StringExclusion Paths Paths to exclude when using client certificates, separated by ;
- client
Certificate StringMode The Client Certificate mode. Possible values are
Required
,Optional
, andOptionalInteractiveUser
. This property has no effect whenclient_cert_enabled
isfalse
- connection
Strings List<Property Map> One or more
connection_string
blocks as defined below.- custom
Domain StringVerification Id The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Hostname String The default hostname of the Windows Web App.
- enabled Boolean
Should the Windows Web App be enabled? Defaults to
true
.- https
Only Boolean Should the Windows Web App require HTTPS connections.
- identity Property Map
An
identity
block as defined below.- key
Vault StringReference Identity Id The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
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.
- outbound
Ip List<String>Address Lists A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- outbound
Ip StringAddresses A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
.- possible
Outbound List<String>Ip Address Lists A
possible_outbound_ip_address_list
block as defined below.- possible
Outbound StringIp Addresses 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 ofoutbound_ip_addresses
.- resource
Group StringName 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 StringId The ID of the Service Plan that this Windows App Service will be created in.
- site
Config Property Map A
site_config
block as defined below.- site
Credentials List<Property Map> A
site_credential
block as defined below.- sticky
Settings Property Map A
sticky_settings
block as defined below.- storage
Accounts List<Property Map> One or more
storage_account
blocks as defined below.- Map<String>
A mapping of tags which should be assigned to the Windows Web App.
- virtual
Network StringSubnet Id The subnet id which will be used by this Web App for regional virtual network integration.
- zip
Deploy StringFile 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?
- Active
Directory WindowsWeb App Auth Settings Active Directory An
active_directory
block as defined above.- Additional
Login Dictionary<string, string>Parameters Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.
- Allowed
External List<string>Redirect Urls Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Windows Web App.
- Default
Provider string The Default Authentication Provider to use when more than one Authentication Provider is configured and the
unauthenticated_action
is set toRedirectToLoginPage
.- Facebook
Windows
Web App Auth Settings Facebook A
facebook
block as defined below.- Github
Windows
Web App Auth Settings Github A
github
block as defined below.- Google
Windows
Web App Auth Settings Google 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
Windows
Web App Auth Settings Microsoft A
microsoft
block as defined below.- Runtime
Version string The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to
~1
.- Token
Refresh doubleExtension Hours The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
hours.- Token
Store boolEnabled Should the Windows Web App durably store platform-specific security tokens that are obtained during login flows? Defaults to
false
.- Twitter
Windows
Web App Auth Settings Twitter A
twitter
block as defined below.- Unauthenticated
Client stringAction The action to take when an unauthenticated client attempts to access the app. Possible values include:
RedirectToLoginPage
,AllowAnonymous
.
- Enabled bool
Should the Authentication / Authorization feature is enabled for the Windows Web App be enabled?
- Active
Directory WindowsWeb App Auth Settings Active Directory An
active_directory
block as defined above.- Additional
Login map[string]stringParameters Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.
- Allowed
External []stringRedirect Urls Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Windows Web App.
- Default
Provider string The Default Authentication Provider to use when more than one Authentication Provider is configured and the
unauthenticated_action
is set toRedirectToLoginPage
.- Facebook
Windows
Web App Auth Settings Facebook A
facebook
block as defined below.- Github
Windows
Web App Auth Settings Github A
github
block as defined below.- Google
Windows
Web App Auth Settings Google 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
Windows
Web App Auth Settings Microsoft A
microsoft
block as defined below.- Runtime
Version string The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to
~1
.- Token
Refresh float64Extension Hours The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
hours.- Token
Store boolEnabled Should the Windows Web App durably store platform-specific security tokens that are obtained during login flows? Defaults to
false
.- Twitter
Windows
Web App Auth Settings Twitter A
twitter
block as defined below.- Unauthenticated
Client stringAction The action to take when an unauthenticated client attempts to access the app. Possible values include:
RedirectToLoginPage
,AllowAnonymous
.
- enabled Boolean
Should the Authentication / Authorization feature is enabled for the Windows Web App be enabled?
- active
Directory WindowsWeb App Auth Settings Active Directory An
active_directory
block as defined above.- additional
Login Map<String,String>Parameters Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.
- allowed
External List<String>Redirect Urls Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Windows Web App.
- default
Provider String The Default Authentication Provider to use when more than one Authentication Provider is configured and the
unauthenticated_action
is set toRedirectToLoginPage
.- facebook
Windows
Web App Auth Settings Facebook A
facebook
block as defined below.- github
Windows
Web App Auth Settings Github A
github
block as defined below.- google
Windows
Web App Auth Settings Google 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
Windows
Web App Auth Settings Microsoft A
microsoft
block as defined below.- runtime
Version String The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to
~1
.- token
Refresh DoubleExtension Hours The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
hours.- token
Store BooleanEnabled Should the Windows Web App durably store platform-specific security tokens that are obtained during login flows? Defaults to
false
.- twitter
Windows
Web App Auth Settings Twitter A
twitter
block as defined below.- unauthenticated
Client StringAction The action to take when an unauthenticated client attempts to access the app. Possible values include:
RedirectToLoginPage
,AllowAnonymous
.
- enabled boolean
Should the Authentication / Authorization feature is enabled for the Windows Web App be enabled?
- active
Directory WindowsWeb App Auth Settings Active Directory An
active_directory
block as defined above.- additional
Login {[key: string]: string}Parameters Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.
- allowed
External string[]Redirect Urls Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Windows Web App.
- default
Provider string The Default Authentication Provider to use when more than one Authentication Provider is configured and the
unauthenticated_action
is set toRedirectToLoginPage
.- facebook
Windows
Web App Auth Settings Facebook A
facebook
block as defined below.- github
Windows
Web App Auth Settings Github A
github
block as defined below.- google
Windows
Web App Auth Settings Google 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
Windows
Web App Auth Settings Microsoft A
microsoft
block as defined below.- runtime
Version string The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to
~1
.- token
Refresh numberExtension Hours The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
hours.- token
Store booleanEnabled Should the Windows Web App durably store platform-specific security tokens that are obtained during login flows? Defaults to
false
.- twitter
Windows
Web App Auth Settings Twitter A
twitter
block as defined below.- unauthenticated
Client stringAction The action to take when an unauthenticated client attempts to access the app. Possible values include:
RedirectToLoginPage
,AllowAnonymous
.
- enabled bool
Should the Authentication / Authorization feature is enabled for the Windows Web App be enabled?
- active_
directory WindowsWeb App Auth Settings Active Directory An
active_directory
block as defined above.- additional_
login_ Mapping[str, str]parameters Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.
- allowed_
external_ Sequence[str]redirect_ urls Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Windows 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 toRedirectToLoginPage
.- facebook
Windows
Web App Auth Settings Facebook A
facebook
block as defined below.- github
Windows
Web App Auth Settings Github A
github
block as defined below.- google
Windows
Web App Auth Settings Google 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
Windows
Web App Auth Settings Microsoft 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_ floatextension_ hours The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
hours.- token_
store_ boolenabled Should the Windows Web App durably store platform-specific security tokens that are obtained during login flows? Defaults to
false
.- twitter
Windows
Web App Auth Settings Twitter A
twitter
block as defined below.- unauthenticated_
client_ straction The action to take when an unauthenticated client attempts to access the app. Possible values include:
RedirectToLoginPage
,AllowAnonymous
.
- enabled Boolean
Should the Authentication / Authorization feature is enabled for the Windows Web App be enabled?
- active
Directory Property Map An
active_directory
block as defined above.- additional
Login Map<String>Parameters Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.
- allowed
External List<String>Redirect Urls Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Windows Web App.
- default
Provider String The Default Authentication Provider to use when more than one Authentication Provider is configured and the
unauthenticated_action
is set toRedirectToLoginPage
.- 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.- runtime
Version String The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to
~1
.- token
Refresh NumberExtension Hours The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
hours.- token
Store BooleanEnabled 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.- unauthenticated
Client StringAction The action to take when an unauthenticated client attempts to access the app. Possible values include:
RedirectToLoginPage
,AllowAnonymous
.
WindowsWebAppAuthSettingsActiveDirectory
- Client
Id string The ID of the Client to use to authenticate with Azure Active Directory.
- Allowed
Audiences List<string> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- Client
Secret string The Client Secret for the Client ID. Cannot be used with
client_secret_setting_name
.- Client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.
- Client
Id string The ID of the Client to use to authenticate with Azure Active Directory.
- Allowed
Audiences []string Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- Client
Secret string The Client Secret for the Client ID. Cannot be used with
client_secret_setting_name
.- Client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.
- client
Id String The ID of the Client to use to authenticate with Azure Active Directory.
- allowed
Audiences List<String> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- client
Secret String The Client Secret for the Client ID. Cannot be used with
client_secret_setting_name
.- client
Secret StringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.
- client
Id string The ID of the Client to use to authenticate with Azure Active Directory.
- allowed
Audiences string[] Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- client
Secret string The Client Secret for the Client ID. Cannot be used with
client_secret_setting_name
.- client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.
- client_
id str The ID of the Client to use to authenticate with Azure Active Directory.
- allowed_
audiences Sequence[str] Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- client_
secret str The Client Secret for the Client ID. Cannot be used with
client_secret_setting_name
.- client_
secret_ strsetting_ name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.
- client
Id String The ID of the Client to use to authenticate with Azure Active Directory.
- allowed
Audiences List<String> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- client
Secret String The Client Secret for the Client ID. Cannot be used with
client_secret_setting_name
.- client
Secret StringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.
WindowsWebAppAuthSettingsFacebook
- App
Id string The App ID of the Facebook app used for login.
- App
Secret string The App Secret of the Facebook app used for Facebook login. Cannot be specified with
app_secret_setting_name
.- App
Secret stringSetting Name The app setting name that contains the
app_secret
value used for Facebook login. Cannot be specified withapp_secret
.- Oauth
Scopes List<string> Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.
- App
Id string The App ID of the Facebook app used for login.
- App
Secret string The App Secret of the Facebook app used for Facebook login. Cannot be specified with
app_secret_setting_name
.- App
Secret stringSetting Name The app setting name that contains the
app_secret
value used for Facebook login. Cannot be specified withapp_secret
.- Oauth
Scopes []string Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.
- app
Id String The App ID of the Facebook app used for login.
- app
Secret String The App Secret of the Facebook app used for Facebook login. Cannot be specified with
app_secret_setting_name
.- app
Secret StringSetting Name The app setting name that contains the
app_secret
value used for Facebook login. Cannot be specified withapp_secret
.- oauth
Scopes List<String> Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.
- app
Id string The App ID of the Facebook app used for login.
- app
Secret string The App Secret of the Facebook app used for Facebook login. Cannot be specified with
app_secret_setting_name
.- app
Secret stringSetting Name The app setting name that contains the
app_secret
value used for Facebook login. Cannot be specified withapp_secret
.- oauth
Scopes string[] Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.
- app_
id str The App ID of the Facebook app used for login.
- app_
secret str The App Secret of the Facebook app used for Facebook login. Cannot be specified with
app_secret_setting_name
.- app_
secret_ strsetting_ name The app setting name that contains the
app_secret
value used for Facebook login. Cannot be specified withapp_secret
.- oauth_
scopes Sequence[str] Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.
- app
Id String The App ID of the Facebook app used for login.
- app
Secret String The App Secret of the Facebook app used for Facebook login. Cannot be specified with
app_secret_setting_name
.- app
Secret StringSetting Name The app setting name that contains the
app_secret
value used for Facebook login. Cannot be specified withapp_secret
.- oauth
Scopes List<String> Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.
WindowsWebAppAuthSettingsGithub
- Client
Id string The ID of the GitHub app used for login.
- Client
Secret string The Client Secret of the GitHub app used for GitHub login. Cannot be specified with
client_secret_setting_name
.- Client
Secret stringSetting Name The app setting name that contains the
client_secret
value used for GitHub login. Cannot be specified withclient_secret
.- Oauth
Scopes List<string> Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.
- Client
Id string The ID of the GitHub app used for login.
- Client
Secret string The Client Secret of the GitHub app used for GitHub login. Cannot be specified with
client_secret_setting_name
.- Client
Secret stringSetting Name The app setting name that contains the
client_secret
value used for GitHub login. Cannot be specified withclient_secret
.- Oauth
Scopes []string Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.
- client
Id String The ID of the GitHub app used for login.
- client
Secret String The Client Secret of the GitHub app used for GitHub login. Cannot be specified with
client_secret_setting_name
.- client
Secret StringSetting Name The app setting name that contains the
client_secret
value used for GitHub login. Cannot be specified withclient_secret
.- oauth
Scopes List<String> Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.
- client
Id string The ID of the GitHub app used for login.
- client
Secret string The Client Secret of the GitHub app used for GitHub login. Cannot be specified with
client_secret_setting_name
.- client
Secret stringSetting Name The app setting name that contains the
client_secret
value used for GitHub login. Cannot be specified withclient_secret
.- oauth
Scopes string[] Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.
- client_
id str The ID of the GitHub app used for login.
- client_
secret str The Client Secret of the GitHub app used for GitHub login. Cannot be specified with
client_secret_setting_name
.- client_
secret_ strsetting_ name The app setting name that contains the
client_secret
value used for GitHub login. Cannot be specified withclient_secret
.- oauth_
scopes Sequence[str] Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.
- client
Id String The ID of the GitHub app used for login.
- client
Secret String The Client Secret of the GitHub app used for GitHub login. Cannot be specified with
client_secret_setting_name
.- client
Secret StringSetting Name The app setting name that contains the
client_secret
value used for GitHub login. Cannot be specified withclient_secret
.- oauth
Scopes List<String> Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.
WindowsWebAppAuthSettingsGoogle
- Client
Id string The OpenID Connect Client ID for the Google web application.
- Client
Secret string The client secret associated with the Google web application. Cannot be specified with
client_secret_setting_name
.- Client
Secret stringSetting Name The app setting name that contains the
client_secret
value used for Google login. Cannot be specified withclient_secret
.- Oauth
Scopes List<string> Specifies a list of OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. If not specified,
openid
,profile
, andemail
are used as default scopes.
- Client
Id string The OpenID Connect Client ID for the Google web application.
- Client
Secret string The client secret associated with the Google web application. Cannot be specified with
client_secret_setting_name
.- Client
Secret stringSetting Name The app setting name that contains the
client_secret
value used for Google login. Cannot be specified withclient_secret
.- Oauth
Scopes []string Specifies a list of OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. If not specified,
openid
,profile
, andemail
are used as default scopes.
- client
Id String The OpenID Connect Client ID for the Google web application.
- client
Secret String The client secret associated with the Google web application. Cannot be specified with
client_secret_setting_name
.- client
Secret StringSetting Name The app setting name that contains the
client_secret
value used for Google login. Cannot be specified withclient_secret
.- oauth
Scopes List<String> Specifies a list of OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. If not specified,
openid
,profile
, andemail
are used as default scopes.
- client
Id string The OpenID Connect Client ID for the Google web application.
- client
Secret string The client secret associated with the Google web application. Cannot be specified with
client_secret_setting_name
.- client
Secret stringSetting Name The app setting name that contains the
client_secret
value used for Google login. Cannot be specified withclient_secret
.- oauth
Scopes string[] Specifies a list of OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. If not specified,
openid
,profile
, andemail
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_ strsetting_ name The app setting name that contains the
client_secret
value used for Google login. Cannot be specified withclient_secret
.- oauth_
scopes Sequence[str] Specifies a list of OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. If not specified,
openid
,profile
, andemail
are used as default scopes.
- client
Id String The OpenID Connect Client ID for the Google web application.
- client
Secret String The client secret associated with the Google web application. Cannot be specified with
client_secret_setting_name
.- client
Secret StringSetting Name The app setting name that contains the
client_secret
value used for Google login. Cannot be specified withclient_secret
.- oauth
Scopes List<String> Specifies a list of OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. If not specified,
openid
,profile
, andemail
are used as default scopes.
WindowsWebAppAuthSettingsMicrosoft
- Client
Id string The OAuth 2.0 client ID that was created for the app used for authentication.
- Client
Secret string The OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with
client_secret_setting_name
.- Client
Secret stringSetting Name The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with
client_secret
.- Oauth
Scopes List<string> Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, "wl.basic" is used as the default scope.
- Client
Id string The OAuth 2.0 client ID that was created for the app used for authentication.
- Client
Secret string The OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with
client_secret_setting_name
.- Client
Secret stringSetting Name The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with
client_secret
.- Oauth
Scopes []string Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, "wl.basic" is used as the default scope.
- client
Id String The OAuth 2.0 client ID that was created for the app used for authentication.
- client
Secret String The OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with
client_secret_setting_name
.- client
Secret StringSetting Name The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with
client_secret
.- oauth
Scopes List<String> Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, "wl.basic" is used as the default scope.
- client
Id string The OAuth 2.0 client ID that was created for the app used for authentication.
- client
Secret string The OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with
client_secret_setting_name
.- client
Secret stringSetting Name The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with
client_secret
.- oauth
Scopes string[] Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, "wl.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_ strsetting_ name The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with
client_secret
.- oauth_
scopes Sequence[str] Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, "wl.basic" is used as the default scope.
- client
Id String The OAuth 2.0 client ID that was created for the app used for authentication.
- client
Secret String The OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with
client_secret_setting_name
.- client
Secret StringSetting Name The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. Cannot be specified with
client_secret
.- oauth
Scopes List<String> Specifies a list of OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. If not specified, "wl.basic" is used as the default scope.
WindowsWebAppAuthSettingsTwitter
- Consumer
Key string The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- Consumer
Secret string The OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with
consumer_secret_setting_name
.- Consumer
Secret stringSetting Name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with
consumer_secret
.
- Consumer
Key string The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- Consumer
Secret string The OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with
consumer_secret_setting_name
.- Consumer
Secret stringSetting Name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with
consumer_secret
.
- consumer
Key String The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer
Secret String The OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with
consumer_secret_setting_name
.- consumer
Secret StringSetting Name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with
consumer_secret
.
- consumer
Key string The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer
Secret string The OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with
consumer_secret_setting_name
.- consumer
Secret stringSetting Name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with
consumer_secret
.
- consumer_
key str The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer_
secret str The OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with
consumer_secret_setting_name
.- consumer_
secret_ strsetting_ name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with
consumer_secret
.
- consumer
Key String The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer
Secret String The OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with
consumer_secret_setting_name
.- consumer
Secret StringSetting Name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. Cannot be specified with
consumer_secret
.
WindowsWebAppAuthSettingsV2
- Login
Windows
Web App Auth Settings V2Login A
login
block as defined below.- Active
Directory WindowsV2 Web App Auth Settings V2Active Directory V2 An
active_directory_v2
block as defined below.- Apple
V2 WindowsWeb App Auth Settings V2Apple V2 An
apple_v2
block as defined below.- Auth
Enabled bool Should the AuthV2 Settings be enabled. Defaults to
false
.- Azure
Static WindowsWeb App V2 Web App Auth Settings V2Azure Static Web App V2 An
azure_static_web_app_v2
block as defined below.- Config
File stringPath The path to the App Auth settings.
- Custom
Oidc List<WindowsV2s Web App Auth Settings V2Custom Oidc V2> Zero or more
custom_oidc_v2
blocks as defined below.- Default
Provider string The default authentication provider to use when multiple providers are configured. Possible values include:
AzureActiveDirectory
,Facebook
,Google
,MicrosoftAccount
,Twitter
,Github
- Excluded
Paths List<string> The paths which should be excluded from the
unauthenticated_action
when it is set toRedirectToLoginPage
.- Facebook
V2 WindowsWeb App Auth Settings V2Facebook V2 A
facebook_v2
block as defined below.- Forward
Proxy stringConvention The convention used to determine the url of the request made. Possible values include
ForwardProxyConventionNoProxy
,ForwardProxyConventionStandard
,ForwardProxyConventionCustom
. Defaults toForwardProxyConventionNoProxy
.- Forward
Proxy stringCustom Host Header Name The name of the custom header containing the host of the request.
- Forward
Proxy stringCustom Scheme Header Name The name of the custom header containing the scheme of the request.
- Github
V2 WindowsWeb App Auth Settings V2Github V2 A
github_v2
block as defined below.- Google
V2 WindowsWeb App Auth Settings V2Google V2 A
google_v2
block as defined below.- Http
Route stringApi Prefix The prefix that should precede all the authentication and authorisation paths. Defaults to
/.auth
.- Microsoft
V2 WindowsWeb App Auth Settings V2Microsoft V2 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 string The RuntimeVersion of the Authentication / Authorization feature in use for the Windows Web App.
- Twitter
V2 WindowsWeb App Auth Settings V2Twitter V2 A
twitter_v2
block as defined below.- Unauthenticated
Action string The action to take for requests made without authentication. Possible values include
RedirectToLoginPage
,AllowAnonymous
,Return401
, andReturn403
. Defaults toRedirectToLoginPage
.
- Login
Windows
Web App Auth Settings V2Login A
login
block as defined below.- Active
Directory WindowsV2 Web App Auth Settings V2Active Directory V2 An
active_directory_v2
block as defined below.- Apple
V2 WindowsWeb App Auth Settings V2Apple V2 An
apple_v2
block as defined below.- Auth
Enabled bool Should the AuthV2 Settings be enabled. Defaults to
false
.- Azure
Static WindowsWeb App V2 Web App Auth Settings V2Azure Static Web App V2 An
azure_static_web_app_v2
block as defined below.- Config
File stringPath The path to the App Auth settings.
- Custom
Oidc []WindowsV2s Web App Auth Settings V2Custom Oidc V2 Zero or more
custom_oidc_v2
blocks as defined below.- Default
Provider string The default authentication provider to use when multiple providers are configured. Possible values include:
AzureActiveDirectory
,Facebook
,Google
,MicrosoftAccount
,Twitter
,Github
- Excluded
Paths []string The paths which should be excluded from the
unauthenticated_action
when it is set toRedirectToLoginPage
.- Facebook
V2 WindowsWeb App Auth Settings V2Facebook V2 A
facebook_v2
block as defined below.- Forward
Proxy stringConvention The convention used to determine the url of the request made. Possible values include
ForwardProxyConventionNoProxy
,ForwardProxyConventionStandard
,ForwardProxyConventionCustom
. Defaults toForwardProxyConventionNoProxy
.- Forward
Proxy stringCustom Host Header Name The name of the custom header containing the host of the request.
- Forward
Proxy stringCustom Scheme Header Name The name of the custom header containing the scheme of the request.
- Github
V2 WindowsWeb App Auth Settings V2Github V2 A
github_v2
block as defined below.- Google
V2 WindowsWeb App Auth Settings V2Google V2 A
google_v2
block as defined below.- Http
Route stringApi Prefix The prefix that should precede all the authentication and authorisation paths. Defaults to
/.auth
.- Microsoft
V2 WindowsWeb App Auth Settings V2Microsoft V2 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 string The RuntimeVersion of the Authentication / Authorization feature in use for the Windows Web App.
- Twitter
V2 WindowsWeb App Auth Settings V2Twitter V2 A
twitter_v2
block as defined below.- Unauthenticated
Action string The action to take for requests made without authentication. Possible values include
RedirectToLoginPage
,AllowAnonymous
,Return401
, andReturn403
. Defaults toRedirectToLoginPage
.
- login
Windows
Web App Auth Settings V2Login A
login
block as defined below.- active
Directory WindowsV2 Web App Auth Settings V2Active Directory V2 An
active_directory_v2
block as defined below.- apple
V2 WindowsWeb App Auth Settings V2Apple V2 An
apple_v2
block as defined below.- auth
Enabled Boolean Should the AuthV2 Settings be enabled. Defaults to
false
.- azure
Static WindowsWeb App V2 Web App Auth Settings V2Azure Static Web App V2 An
azure_static_web_app_v2
block as defined below.- config
File StringPath The path to the App Auth settings.
- custom
Oidc List<WindowsV2s Web App Auth Settings V2Custom Oidc V2> Zero or more
custom_oidc_v2
blocks as defined below.- default
Provider String The default authentication provider to use when multiple providers are configured. Possible values include:
AzureActiveDirectory
,Facebook
,Google
,MicrosoftAccount
,Twitter
,Github
- excluded
Paths List<String> The paths which should be excluded from the
unauthenticated_action
when it is set toRedirectToLoginPage
.- facebook
V2 WindowsWeb App Auth Settings V2Facebook V2 A
facebook_v2
block as defined below.- forward
Proxy StringConvention The convention used to determine the url of the request made. Possible values include
ForwardProxyConventionNoProxy
,ForwardProxyConventionStandard
,ForwardProxyConventionCustom
. Defaults toForwardProxyConventionNoProxy
.- forward
Proxy StringCustom Host Header Name The name of the custom header containing the host of the request.
- forward
Proxy StringCustom Scheme Header Name The name of the custom header containing the scheme of the request.
- github
V2 WindowsWeb App Auth Settings V2Github V2 A
github_v2
block as defined below.- google
V2 WindowsWeb App Auth Settings V2Google V2 A
google_v2
block as defined below.- http
Route StringApi Prefix The prefix that should precede all the authentication and authorisation paths. Defaults to
/.auth
.- microsoft
V2 WindowsWeb App Auth Settings V2Microsoft V2 A
microsoft_v2
block as defined below.- require
Authentication Boolean Should the authentication flow be used for all requests.
- require
Https Boolean Should HTTPS be required on connections? Defaults to
true
.- runtime
Version String The RuntimeVersion of the Authentication / Authorization feature in use for the Windows Web App.
- twitter
V2 WindowsWeb App Auth Settings V2Twitter V2 A
twitter_v2
block as defined below.- unauthenticated
Action String The action to take for requests made without authentication. Possible values include
RedirectToLoginPage
,AllowAnonymous
,Return401
, andReturn403
. Defaults toRedirectToLoginPage
.
- login
Windows
Web App Auth Settings V2Login A
login
block as defined below.- active
Directory WindowsV2 Web App Auth Settings V2Active Directory V2 An
active_directory_v2
block as defined below.- apple
V2 WindowsWeb App Auth Settings V2Apple V2 An
apple_v2
block as defined below.- auth
Enabled boolean Should the AuthV2 Settings be enabled. Defaults to
false
.- azure
Static WindowsWeb App V2 Web App Auth Settings V2Azure Static Web App V2 An
azure_static_web_app_v2
block as defined below.- config
File stringPath The path to the App Auth settings.
- custom
Oidc WindowsV2s Web App Auth Settings V2Custom Oidc V2[] Zero or more
custom_oidc_v2
blocks as defined below.- default
Provider string The default authentication provider to use when multiple providers are configured. Possible values include:
AzureActiveDirectory
,Facebook
,Google
,MicrosoftAccount
,Twitter
,Github
- excluded
Paths string[] The paths which should be excluded from the
unauthenticated_action
when it is set toRedirectToLoginPage
.- facebook
V2 WindowsWeb App Auth Settings V2Facebook V2 A
facebook_v2
block as defined below.- forward
Proxy stringConvention The convention used to determine the url of the request made. Possible values include
ForwardProxyConventionNoProxy
,ForwardProxyConventionStandard
,ForwardProxyConventionCustom
. Defaults toForwardProxyConventionNoProxy
.- forward
Proxy stringCustom Host Header Name The name of the custom header containing the host of the request.
- forward
Proxy stringCustom Scheme Header Name The name of the custom header containing the scheme of the request.
- github
V2 WindowsWeb App Auth Settings V2Github V2 A
github_v2
block as defined below.- google
V2 WindowsWeb App Auth Settings V2Google V2 A
google_v2
block as defined below.- http
Route stringApi Prefix The prefix that should precede all the authentication and authorisation paths. Defaults to
/.auth
.- microsoft
V2 WindowsWeb App Auth Settings V2Microsoft V2 A
microsoft_v2
block as defined below.- require
Authentication boolean Should the authentication flow be used for all requests.
- require
Https boolean Should HTTPS be required on connections? Defaults to
true
.- runtime
Version string The RuntimeVersion of the Authentication / Authorization feature in use for the Windows Web App.
- twitter
V2 WindowsWeb App Auth Settings V2Twitter V2 A
twitter_v2
block as defined below.- unauthenticated
Action string The action to take for requests made without authentication. Possible values include
RedirectToLoginPage
,AllowAnonymous
,Return401
, andReturn403
. Defaults toRedirectToLoginPage
.
- login
Windows
Web App Auth Settings V2Login A
login
block as defined below.- active_
directory_ Windowsv2 Web App Auth Settings V2Active Directory V2 An
active_directory_v2
block as defined below.- apple_
v2 WindowsWeb App Auth Settings V2Apple V2 An
apple_v2
block as defined below.- auth_
enabled bool Should the AuthV2 Settings be enabled. Defaults to
false
.- azure_
static_ Windowsweb_ app_ v2 Web App Auth Settings V2Azure Static Web App V2 An
azure_static_web_app_v2
block as defined below.- config_
file_ strpath The path to the App Auth settings.
- custom_
oidc_ Sequence[Windowsv2s Web App Auth Settings V2Custom Oidc V2] 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 toRedirectToLoginPage
.- facebook_
v2 WindowsWeb App Auth Settings V2Facebook V2 A
facebook_v2
block as defined below.- forward_
proxy_ strconvention The convention used to determine the url of the request made. Possible values include
ForwardProxyConventionNoProxy
,ForwardProxyConventionStandard
,ForwardProxyConventionCustom
. Defaults toForwardProxyConventionNoProxy
.- forward_
proxy_ strcustom_ host_ header_ name The name of the custom header containing the host of the request.
- forward_
proxy_ strcustom_ scheme_ header_ name The name of the custom header containing the scheme of the request.
- github_
v2 WindowsWeb App Auth Settings V2Github V2 A
github_v2
block as defined below.- google_
v2 WindowsWeb App Auth Settings V2Google V2 A
google_v2
block as defined below.- http_
route_ strapi_ prefix The prefix that should precede all the authentication and authorisation paths. Defaults to
/.auth
.- microsoft_
v2 WindowsWeb App Auth Settings V2Microsoft V2 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 WindowsWeb App Auth Settings V2Twitter V2 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
, andReturn403
. Defaults toRedirectToLoginPage
.
- login Property Map
A
login
block as defined below.- active
Directory Property MapV2 An
active_directory_v2
block as defined below.- apple
V2 Property Map An
apple_v2
block as defined below.- auth
Enabled Boolean Should the AuthV2 Settings be enabled. Defaults to
false
.- azure
Static Property MapWeb App V2 An
azure_static_web_app_v2
block as defined below.- config
File StringPath The path to the App Auth settings.
- custom
Oidc List<Property Map>V2s Zero or more
custom_oidc_v2
blocks as defined below.- default
Provider String The default authentication provider to use when multiple providers are configured. Possible values include:
AzureActiveDirectory
,Facebook
,Google
,MicrosoftAccount
,Twitter
,Github
- excluded
Paths List<String> The paths which should be excluded from the
unauthenticated_action
when it is set toRedirectToLoginPage
.- facebook
V2 Property Map A
facebook_v2
block as defined below.- forward
Proxy StringConvention The convention used to determine the url of the request made. Possible values include
ForwardProxyConventionNoProxy
,ForwardProxyConventionStandard
,ForwardProxyConventionCustom
. Defaults toForwardProxyConventionNoProxy
.- forward
Proxy StringCustom Host Header Name The name of the custom header containing the host of the request.
- forward
Proxy StringCustom Scheme Header Name The name of the custom header containing the scheme of the request.
- github
V2 Property Map A
github_v2
block as defined below.- google
V2 Property Map A
google_v2
block as defined below.- http
Route StringApi Prefix The prefix that should precede all the authentication and authorisation paths. Defaults to
/.auth
.- microsoft
V2 Property Map A
microsoft_v2
block as defined below.- require
Authentication Boolean Should the authentication flow be used for all requests.
- require
Https Boolean Should HTTPS be required on connections? Defaults to
true
.- runtime
Version String The RuntimeVersion of the Authentication / Authorization feature in use for the Windows Web App.
- twitter
V2 Property Map A
twitter_v2
block as defined below.- unauthenticated
Action String The action to take for requests made without authentication. Possible values include
RedirectToLoginPage
,AllowAnonymous
,Return401
, andReturn403
. Defaults toRedirectToLoginPage
.
WindowsWebAppAuthSettingsV2ActiveDirectoryV2
- Client
Id string The ID of the Client to use to authenticate with Azure Active Directory.
- Tenant
Auth stringEndpoint The Azure Tenant Endpoint for the Authenticating Tenant. e.g.
https://login.microsoftonline.com/v2.0/{tenant-guid}/
- Allowed
Applications List<string> The list of allowed Applications for the Default Authorisation Policy.
- Allowed
Audiences List<string> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- Allowed
Groups List<string> The list of allowed Group Names for the Default Authorisation Policy.
- Allowed
Identities List<string> The list of allowed Identities for the Default Authorisation Policy.
- Client
Secret stringCertificate Thumbprint The thumbprint of the certificate used for signing purposes.
- Client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- Jwt
Allowed List<string>Client Applications A list of Allowed Client Applications in the JWT Claim.
- Jwt
Allowed List<string>Groups A list of Allowed Groups in the JWT Claim.
- Login
Parameters Dictionary<string, string> A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
- Www
Authentication boolDisabled Should the www-authenticate provider should be omitted from the request? Defaults to
false
- Client
Id string The ID of the Client to use to authenticate with Azure Active Directory.
- Tenant
Auth stringEndpoint The Azure Tenant Endpoint for the Authenticating Tenant. e.g.
https://login.microsoftonline.com/v2.0/{tenant-guid}/
- Allowed
Applications []string The list of allowed Applications for the Default Authorisation Policy.
- Allowed
Audiences []string Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- Allowed
Groups []string The list of allowed Group Names for the Default Authorisation Policy.
- Allowed
Identities []string The list of allowed Identities for the Default Authorisation Policy.
- Client
Secret stringCertificate Thumbprint The thumbprint of the certificate used for signing purposes.
- Client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- Jwt
Allowed []stringClient Applications A list of Allowed Client Applications in the JWT Claim.
- Jwt
Allowed []stringGroups A list of Allowed Groups in the JWT Claim.
- Login
Parameters map[string]string A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
- Www
Authentication boolDisabled Should the www-authenticate provider should be omitted from the request? Defaults to
false
- client
Id String The ID of the Client to use to authenticate with Azure Active Directory.
- tenant
Auth StringEndpoint The Azure Tenant Endpoint for the Authenticating Tenant. e.g.
https://login.microsoftonline.com/v2.0/{tenant-guid}/
- allowed
Applications List<String> The list of allowed Applications for the Default Authorisation Policy.
- allowed
Audiences List<String> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- allowed
Groups List<String> The list of allowed Group Names for the Default Authorisation Policy.
- allowed
Identities List<String> The list of allowed Identities for the Default Authorisation Policy.
- client
Secret StringCertificate Thumbprint The thumbprint of the certificate used for signing purposes.
- client
Secret StringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- jwt
Allowed List<String>Client Applications A list of Allowed Client Applications in the JWT Claim.
- jwt
Allowed List<String>Groups A list of Allowed Groups in the JWT Claim.
- login
Parameters Map<String,String> A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
- www
Authentication BooleanDisabled Should the www-authenticate provider should be omitted from the request? Defaults to
false
- client
Id string The ID of the Client to use to authenticate with Azure Active Directory.
- tenant
Auth stringEndpoint The Azure Tenant Endpoint for the Authenticating Tenant. e.g.
https://login.microsoftonline.com/v2.0/{tenant-guid}/
- allowed
Applications string[] The list of allowed Applications for the Default Authorisation Policy.
- allowed
Audiences string[] Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- allowed
Groups string[] The list of allowed Group Names for the Default Authorisation Policy.
- allowed
Identities string[] The list of allowed Identities for the Default Authorisation Policy.
- client
Secret stringCertificate Thumbprint The thumbprint of the certificate used for signing purposes.
- client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- jwt
Allowed string[]Client Applications A list of Allowed Client Applications in the JWT Claim.
- jwt
Allowed string[]Groups A list of Allowed Groups in the JWT Claim.
- login
Parameters {[key: string]: string} A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
- www
Authentication booleanDisabled Should the www-authenticate provider should be omitted from the request? Defaults to
false
- client_
id str The ID of the Client to use to authenticate with Azure Active Directory.
- tenant_
auth_ strendpoint The Azure Tenant Endpoint for the Authenticating Tenant. e.g.
https://login.microsoftonline.com/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_ strcertificate_ thumbprint The thumbprint of the certificate used for signing purposes.
- client_
secret_ strsetting_ name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- jwt_
allowed_ Sequence[str]client_ applications A list of Allowed Client Applications in the JWT Claim.
- jwt_
allowed_ Sequence[str]groups A list of Allowed Groups in the JWT Claim.
- login_
parameters Mapping[str, str] A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
- www_
authentication_ booldisabled Should the www-authenticate provider should be omitted from the request? Defaults to
false
- client
Id String The ID of the Client to use to authenticate with Azure Active Directory.
- tenant
Auth StringEndpoint The Azure Tenant Endpoint for the Authenticating Tenant. e.g.
https://login.microsoftonline.com/v2.0/{tenant-guid}/
- allowed
Applications List<String> The list of allowed Applications for the Default Authorisation Policy.
- allowed
Audiences List<String> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- allowed
Groups List<String> The list of allowed Group Names for the Default Authorisation Policy.
- allowed
Identities List<String> The list of allowed Identities for the Default Authorisation Policy.
- client
Secret StringCertificate Thumbprint The thumbprint of the certificate used for signing purposes.
- client
Secret StringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- jwt
Allowed List<String>Client Applications A list of Allowed Client Applications in the JWT Claim.
- jwt
Allowed List<String>Groups A list of Allowed Groups in the JWT Claim.
- login
Parameters Map<String> A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
- www
Authentication BooleanDisabled Should the www-authenticate provider should be omitted from the request? Defaults to
false
WindowsWebAppAuthSettingsV2AppleV2
- Client
Id string The ID of the Client to use to authenticate with Azure Active Directory.
- Client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- Login
Scopes List<string> A list of Login Scopes provided by this Authentication Provider.
- Client
Id string The ID of the Client to use to authenticate with Azure Active Directory.
- Client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- Login
Scopes []string A list of Login Scopes provided by this Authentication Provider.
- client
Id String The ID of the Client to use to authenticate with Azure Active Directory.
- client
Secret StringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- login
Scopes List<String> A list of Login Scopes provided by this Authentication Provider.
- client
Id string The ID of the Client to use to authenticate with Azure Active Directory.
- client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- login
Scopes 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_ strsetting_ name 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.
- client
Id String The ID of the Client to use to authenticate with Azure Active Directory.
- client
Secret StringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- login
Scopes List<String> A list of Login Scopes provided by this Authentication Provider.
WindowsWebAppAuthSettingsV2AzureStaticWebAppV2
- Client
Id string The ID of the Client to use to authenticate with Azure Active Directory.
- Client
Id string The ID of the Client to use to authenticate with Azure Active Directory.
- client
Id String The ID of the Client to use to authenticate with Azure Active Directory.
- client
Id 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.
- client
Id String The ID of the Client to use to authenticate with Azure Active Directory.
WindowsWebAppAuthSettingsV2CustomOidcV2
- Client
Id 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.
- Openid
Configuration stringEndpoint The app setting name that contains the
client_secret
value used for the Custom OIDC Login.- string
The endpoint to make the Authorisation Request as supplied by
openid_configuration_endpoint
response.- Certification
Uri string The endpoint that provides the keys necessary to validate the token as supplied by
openid_configuration_endpoint
response.- Client
Credential stringMethod The Client Credential Method used.
- Client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- Issuer
Endpoint string The endpoint that issued the Token as supplied by
openid_configuration_endpoint
response.- Name
Claim stringType The name of the claim that contains the users name.
- Scopes List<string>
The list of the scopes that should be requested while authenticating.
- Token
Endpoint string The endpoint used to request a Token as supplied by
openid_configuration_endpoint
response.
- Client
Id 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.
- Openid
Configuration stringEndpoint The app setting name that contains the
client_secret
value used for the Custom OIDC Login.- string
The endpoint to make the Authorisation Request as supplied by
openid_configuration_endpoint
response.- Certification
Uri string The endpoint that provides the keys necessary to validate the token as supplied by
openid_configuration_endpoint
response.- Client
Credential stringMethod The Client Credential Method used.
- Client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- Issuer
Endpoint string The endpoint that issued the Token as supplied by
openid_configuration_endpoint
response.- Name
Claim stringType The name of the claim that contains the users name.
- Scopes []string
The list of the scopes that should be requested while authenticating.
- Token
Endpoint string The endpoint used to request a Token as supplied by
openid_configuration_endpoint
response.
- client
Id 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.
- openid
Configuration StringEndpoint The app setting name that contains the
client_secret
value used for the Custom OIDC Login.- String
The endpoint to make the Authorisation Request as supplied by
openid_configuration_endpoint
response.- certification
Uri String The endpoint that provides the keys necessary to validate the token as supplied by
openid_configuration_endpoint
response.- client
Credential StringMethod The Client Credential Method used.
- client
Secret StringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- issuer
Endpoint String The endpoint that issued the Token as supplied by
openid_configuration_endpoint
response.- name
Claim StringType The name of the claim that contains the users name.
- scopes List<String>
The list of the scopes that should be requested while authenticating.
- token
Endpoint String The endpoint used to request a Token as supplied by
openid_configuration_endpoint
response.
- client
Id 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.
- openid
Configuration stringEndpoint The app setting name that contains the
client_secret
value used for the Custom OIDC Login.- string
The endpoint to make the Authorisation Request as supplied by
openid_configuration_endpoint
response.- certification
Uri string The endpoint that provides the keys necessary to validate the token as supplied by
openid_configuration_endpoint
response.- client
Credential stringMethod The Client Credential Method used.
- client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- issuer
Endpoint string The endpoint that issued the Token as supplied by
openid_configuration_endpoint
response.- name
Claim stringType The name of the claim that contains the users name.
- scopes string[]
The list of the scopes that should be requested while authenticating.
- token
Endpoint string The endpoint used to request a Token as supplied by
openid_configuration_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_ strendpoint The app setting name that contains the
client_secret
value used for the Custom OIDC Login.- 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_ strmethod The Client Credential Method used.
- client_
secret_ strsetting_ name 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_ strtype The name of the claim that contains the users name.
- scopes Sequence[str]
The list of the scopes that should be requested while authenticating.
- token_
endpoint str The endpoint used to request a Token as supplied by
openid_configuration_endpoint
response.
- client
Id 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.
- openid
Configuration StringEndpoint The app setting name that contains the
client_secret
value used for the Custom OIDC Login.- String
The endpoint to make the Authorisation Request as supplied by
openid_configuration_endpoint
response.- certification
Uri String The endpoint that provides the keys necessary to validate the token as supplied by
openid_configuration_endpoint
response.- client
Credential StringMethod The Client Credential Method used.
- client
Secret StringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- issuer
Endpoint String The endpoint that issued the Token as supplied by
openid_configuration_endpoint
response.- name
Claim StringType The name of the claim that contains the users name.
- scopes List<String>
The list of the scopes that should be requested while authenticating.
- token
Endpoint String The endpoint used to request a Token as supplied by
openid_configuration_endpoint
response.
WindowsWebAppAuthSettingsV2FacebookV2
- App
Id string The App ID of the Facebook app used for login.
- App
Secret stringSetting Name The app setting name that contains the
app_secret
value used for Facebook Login.- Graph
Api stringVersion The version of the Facebook API to be used while logging in.
- Login
Scopes List<string> A list of Login Scopes provided by this Authentication Provider.
- App
Id string The App ID of the Facebook app used for login.
- App
Secret stringSetting Name The app setting name that contains the
app_secret
value used for Facebook Login.- Graph
Api stringVersion The version of the Facebook API to be used while logging in.
- Login
Scopes []string A list of Login Scopes provided by this Authentication Provider.
- app
Id String The App ID of the Facebook app used for login.
- app
Secret StringSetting Name The app setting name that contains the
app_secret
value used for Facebook Login.- graph
Api StringVersion The version of the Facebook API to be used while logging in.
- login
Scopes List<String> A list of Login Scopes provided by this Authentication Provider.
- app
Id string The App ID of the Facebook app used for login.
- app
Secret stringSetting Name The app setting name that contains the
app_secret
value used for Facebook Login.- graph
Api stringVersion The version of the Facebook API to be used while logging in.
- login
Scopes 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_ strsetting_ name The app setting name that contains the
app_secret
value used for Facebook Login.- graph_
api_ strversion 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.
- app
Id String The App ID of the Facebook app used for login.
- app
Secret StringSetting Name The app setting name that contains the
app_secret
value used for Facebook Login.- graph
Api StringVersion The version of the Facebook API to be used while logging in.
- login
Scopes List<String> A list of Login Scopes provided by this Authentication Provider.
WindowsWebAppAuthSettingsV2GithubV2
- Client
Id string The ID of the Client to use to authenticate with Azure Active Directory.
- Client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- Login
Scopes List<string> A list of Login Scopes provided by this Authentication Provider.
- Client
Id string The ID of the Client to use to authenticate with Azure Active Directory.
- Client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- Login
Scopes []string A list of Login Scopes provided by this Authentication Provider.
- client
Id String The ID of the Client to use to authenticate with Azure Active Directory.
- client
Secret StringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- login
Scopes List<String> A list of Login Scopes provided by this Authentication Provider.
- client
Id string The ID of the Client to use to authenticate with Azure Active Directory.
- client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- login
Scopes 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_ strsetting_ name 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.
- client
Id String The ID of the Client to use to authenticate with Azure Active Directory.
- client
Secret StringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- login
Scopes List<String> A list of Login Scopes provided by this Authentication Provider.
WindowsWebAppAuthSettingsV2GoogleV2
- Client
Id string The ID of the Client to use to authenticate with Azure Active Directory.
- Client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- Allowed
Audiences List<string> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- Login
Scopes List<string> A list of Login Scopes provided by this Authentication Provider.
- Client
Id string The ID of the Client to use to authenticate with Azure Active Directory.
- Client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- Allowed
Audiences []string Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- Login
Scopes []string A list of Login Scopes provided by this Authentication Provider.
- client
Id String The ID of the Client to use to authenticate with Azure Active Directory.
- client
Secret StringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- allowed
Audiences List<String> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- login
Scopes List<String> A list of Login Scopes provided by this Authentication Provider.
- client
Id string The ID of the Client to use to authenticate with Azure Active Directory.
- client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- allowed
Audiences string[] Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- login
Scopes 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_ strsetting_ name 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.
- client
Id String The ID of the Client to use to authenticate with Azure Active Directory.
- client
Secret StringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- allowed
Audiences List<String> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- login
Scopes List<String> A list of Login Scopes provided by this Authentication Provider.
WindowsWebAppAuthSettingsV2Login
- Allowed
External List<string>Redirect Urls External URLs that can be redirected to as part of logging in or logging out of the app. This is an advanced setting typically only needed by Windows Store application backends.
- string
The method by which cookies expire. Possible values include:
FixedTime
, andIdentityProviderDerived
. Defaults toFixedTime
.- string
The time after the request is made when the session cookie should expire. Defaults to
08:00:00
.- Logout
Endpoint string The endpoint to which logout requests should be made.
- Nonce
Expiration stringTime The time after the request is made when the nonce should expire. Defaults to
00:05:00
.- Preserve
Url boolFragments For Logins Should the fragments from the request be preserved after the login request is made. Defaults to
false
.- Token
Refresh doubleExtension Time The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
hours.- Token
Store boolEnabled Should the Token Store configuration Enabled. Defaults to
false
- Token
Store stringPath The directory path in the App Filesystem in which the tokens will be stored.
- Token
Store stringSas Setting Name The name of the app setting which contains the SAS URL of the blob storage containing the tokens.
- Validate
Nonce bool Should the nonce be validated while completing the login flow. Defaults to
true
.
- Allowed
External []stringRedirect Urls External URLs that can be redirected to as part of logging in or logging out of the app. This is an advanced setting typically only needed by Windows Store application backends.
- string
The method by which cookies expire. Possible values include:
FixedTime
, andIdentityProviderDerived
. Defaults toFixedTime
.- string
The time after the request is made when the session cookie should expire. Defaults to
08:00:00
.- Logout
Endpoint string The endpoint to which logout requests should be made.
- Nonce
Expiration stringTime The time after the request is made when the nonce should expire. Defaults to
00:05:00
.- Preserve
Url boolFragments For Logins Should the fragments from the request be preserved after the login request is made. Defaults to
false
.- Token
Refresh float64Extension Time The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
hours.- Token
Store boolEnabled Should the Token Store configuration Enabled. Defaults to
false
- Token
Store stringPath The directory path in the App Filesystem in which the tokens will be stored.
- Token
Store stringSas Setting Name The name of the app setting which contains the SAS URL of the blob storage containing the tokens.
- Validate
Nonce bool Should the nonce be validated while completing the login flow. Defaults to
true
.
- allowed
External List<String>Redirect Urls External URLs that can be redirected to as part of logging in or logging out of the app. This is an advanced setting typically only needed by Windows Store application backends.
- String
The method by which cookies expire. Possible values include:
FixedTime
, andIdentityProviderDerived
. Defaults toFixedTime
.- String
The time after the request is made when the session cookie should expire. Defaults to
08:00:00
.- logout
Endpoint String The endpoint to which logout requests should be made.
- nonce
Expiration StringTime The time after the request is made when the nonce should expire. Defaults to
00:05:00
.- preserve
Url BooleanFragments For Logins Should the fragments from the request be preserved after the login request is made. Defaults to
false
.- token
Refresh DoubleExtension Time The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
hours.- token
Store BooleanEnabled Should the Token Store configuration Enabled. Defaults to
false
- token
Store StringPath The directory path in the App Filesystem in which the tokens will be stored.
- token
Store StringSas Setting Name The name of the app setting which contains the SAS URL of the blob storage containing the tokens.
- validate
Nonce Boolean Should the nonce be validated while completing the login flow. Defaults to
true
.
- allowed
External string[]Redirect Urls External URLs that can be redirected to as part of logging in or logging out of the app. This is an advanced setting typically only needed by Windows Store application backends.
- string
The method by which cookies expire. Possible values include:
FixedTime
, andIdentityProviderDerived
. Defaults toFixedTime
.- string
The time after the request is made when the session cookie should expire. Defaults to
08:00:00
.- logout
Endpoint string The endpoint to which logout requests should be made.
- nonce
Expiration stringTime The time after the request is made when the nonce should expire. Defaults to
00:05:00
.- preserve
Url booleanFragments For Logins Should the fragments from the request be preserved after the login request is made. Defaults to
false
.- token
Refresh numberExtension Time The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
hours.- token
Store booleanEnabled Should the Token Store configuration Enabled. Defaults to
false
- token
Store stringPath The directory path in the App Filesystem in which the tokens will be stored.
- token
Store stringSas Setting Name The name of the app setting which contains the SAS URL of the blob storage containing the tokens.
- validate
Nonce boolean Should the nonce be validated while completing the login flow. Defaults to
true
.
- allowed_
external_ Sequence[str]redirect_ urls External URLs that can be redirected to as part of logging in or logging out of the app. This is an advanced setting typically only needed by Windows Store application backends.
- str
The method by which cookies expire. Possible values include:
FixedTime
, andIdentityProviderDerived
. Defaults toFixedTime
.- str
The time after the request is made when the session cookie should expire. Defaults to
08:00:00
.- logout_
endpoint str The endpoint to which logout requests should be made.
- nonce_
expiration_ strtime The time after the request is made when the nonce should expire. Defaults to
00:05:00
.- preserve_
url_ boolfragments_ for_ logins Should the fragments from the request be preserved after the login request is made. Defaults to
false
.- token_
refresh_ floatextension_ time The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
hours.- token_
store_ boolenabled Should the Token Store configuration Enabled. Defaults to
false
- token_
store_ strpath The directory path in the App Filesystem in which the tokens will be stored.
- token_
store_ strsas_ setting_ name The name of the app setting which contains the SAS URL of the blob storage containing the tokens.
- validate_
nonce bool Should the nonce be validated while completing the login flow. Defaults to
true
.
- allowed
External List<String>Redirect Urls External URLs that can be redirected to as part of logging in or logging out of the app. This is an advanced setting typically only needed by Windows Store application backends.
- String
The method by which cookies expire. Possible values include:
FixedTime
, andIdentityProviderDerived
. Defaults toFixedTime
.- String
The time after the request is made when the session cookie should expire. Defaults to
08:00:00
.- logout
Endpoint String The endpoint to which logout requests should be made.
- nonce
Expiration StringTime The time after the request is made when the nonce should expire. Defaults to
00:05:00
.- preserve
Url BooleanFragments For Logins Should the fragments from the request be preserved after the login request is made. Defaults to
false
.- token
Refresh NumberExtension Time The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
hours.- token
Store BooleanEnabled Should the Token Store configuration Enabled. Defaults to
false
- token
Store StringPath The directory path in the App Filesystem in which the tokens will be stored.
- token
Store StringSas Setting Name The name of the app setting which contains the SAS URL of the blob storage containing the tokens.
- validate
Nonce Boolean Should the nonce be validated while completing the login flow. Defaults to
true
.
WindowsWebAppAuthSettingsV2MicrosoftV2
- Client
Id string The ID of the Client to use to authenticate with Azure Active Directory.
- Client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- Allowed
Audiences List<string> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- Login
Scopes List<string> A list of Login Scopes provided by this Authentication Provider.
- Client
Id string The ID of the Client to use to authenticate with Azure Active Directory.
- Client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- Allowed
Audiences []string Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- Login
Scopes []string A list of Login Scopes provided by this Authentication Provider.
- client
Id String The ID of the Client to use to authenticate with Azure Active Directory.
- client
Secret StringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- allowed
Audiences List<String> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- login
Scopes List<String> A list of Login Scopes provided by this Authentication Provider.
- client
Id string The ID of the Client to use to authenticate with Azure Active Directory.
- client
Secret stringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- allowed
Audiences string[] Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- login
Scopes 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_ strsetting_ name 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.
- client
Id String The ID of the Client to use to authenticate with Azure Active Directory.
- client
Secret StringSetting Name The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret
.- allowed
Audiences List<String> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- login
Scopes List<String> A list of Login Scopes provided by this Authentication Provider.
WindowsWebAppAuthSettingsV2TwitterV2
- Consumer
Key string The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- Consumer
Secret stringSetting Name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
- Consumer
Key string The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- Consumer
Secret stringSetting Name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
- consumer
Key String The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer
Secret StringSetting Name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
- consumer
Key string The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer
Secret stringSetting Name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
- consumer_
key str The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer_
secret_ strsetting_ name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
- consumer
Key String The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer
Secret StringSetting Name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
WindowsWebAppBackup
- Name string
The name which should be used for this Backup.
- Schedule
Windows
Web App Backup Schedule A
schedule
block as defined below.- Storage
Account stringUrl The SAS URL to the container.
- Enabled bool
Should this backup job be enabled? Defaults to
true
.
- Name string
The name which should be used for this Backup.
- Schedule
Windows
Web App Backup Schedule A
schedule
block as defined below.- Storage
Account stringUrl The SAS URL to the container.
- Enabled bool
Should this backup job be enabled? Defaults to
true
.
- name String
The name which should be used for this Backup.
- schedule
Windows
Web App Backup Schedule A
schedule
block as defined below.- storage
Account StringUrl The SAS URL to the container.
- enabled Boolean
Should this backup job be enabled? Defaults to
true
.
- name string
The name which should be used for this Backup.
- schedule
Windows
Web App Backup Schedule A
schedule
block as defined below.- storage
Account stringUrl The SAS URL to the container.
- enabled boolean
Should this backup job be enabled? Defaults to
true
.
- name str
The name which should be used for this Backup.
- schedule
Windows
Web App Backup Schedule A
schedule
block as defined below.- storage_
account_ strurl The SAS URL to the container.
- enabled bool
Should this backup job be enabled? Defaults to
true
.
- name String
The name which should be used for this Backup.
- schedule Property Map
A
schedule
block as defined below.- storage
Account StringUrl The SAS URL to the container.
- enabled Boolean
Should this backup job be enabled? Defaults to
true
.
WindowsWebAppBackupSchedule
- Frequency
Interval int How often the backup should be executed (e.g. for weekly backup, this should be set to
7
andfrequency_unit
should be set toDay
).- Frequency
Unit string The unit of time for how often the backup should take place. Possible values include:
Day
,Hour
- Keep
At boolLeast One Backup Should the service keep at least one backup, regardless of age of backup. Defaults to
false
.- Last
Execution stringTime - Retention
Period intDays After how many days backups should be deleted. Defaults to
30
.- Start
Time string When the schedule should start working in RFC-3339 format.
- Frequency
Interval int How often the backup should be executed (e.g. for weekly backup, this should be set to
7
andfrequency_unit
should be set toDay
).- Frequency
Unit string The unit of time for how often the backup should take place. Possible values include:
Day
,Hour
- Keep
At boolLeast One Backup Should the service keep at least one backup, regardless of age of backup. Defaults to
false
.- Last
Execution stringTime - Retention
Period intDays After how many days backups should be deleted. Defaults to
30
.- Start
Time string When the schedule should start working in RFC-3339 format.
- frequency
Interval Integer How often the backup should be executed (e.g. for weekly backup, this should be set to
7
andfrequency_unit
should be set toDay
).- frequency
Unit String The unit of time for how often the backup should take place. Possible values include:
Day
,Hour
- keep
At BooleanLeast One Backup Should the service keep at least one backup, regardless of age of backup. Defaults to
false
.- last
Execution StringTime - retention
Period IntegerDays After how many days backups should be deleted. Defaults to
30
.- start
Time String When the schedule should start working in RFC-3339 format.
- frequency
Interval number How often the backup should be executed (e.g. for weekly backup, this should be set to
7
andfrequency_unit
should be set toDay
).- frequency
Unit string The unit of time for how often the backup should take place. Possible values include:
Day
,Hour
- keep
At booleanLeast One Backup Should the service keep at least one backup, regardless of age of backup. Defaults to
false
.- last
Execution stringTime - retention
Period numberDays After how many days backups should be deleted. Defaults to
30
.- start
Time string When the schedule should start working in RFC-3339 format.
- frequency_
interval int How often the backup should be executed (e.g. for weekly backup, this should be set to
7
andfrequency_unit
should be set toDay
).- frequency_
unit str The unit of time for how often the backup should take place. Possible values include:
Day
,Hour
- keep_
at_ boolleast_ one_ backup Should the service keep at least one backup, regardless of age of backup. Defaults to
false
.- last_
execution_ strtime - retention_
period_ intdays After how many days backups should be deleted. Defaults to
30
.- start_
time str When the schedule should start working in RFC-3339 format.
- frequency
Interval Number How often the backup should be executed (e.g. for weekly backup, this should be set to
7
andfrequency_unit
should be set toDay
).- frequency
Unit String The unit of time for how often the backup should take place. Possible values include:
Day
,Hour
- keep
At BooleanLeast One Backup Should the service keep at least one backup, regardless of age of backup. Defaults to
false
.- last
Execution StringTime - retention
Period NumberDays After how many days backups should be deleted. Defaults to
30
.- start
Time String When the schedule should start working in RFC-3339 format.
WindowsWebAppConnectionString
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).- Identity
Ids List<string> A list of User Assigned Managed Identity IDs to be assigned to this Windows Web App.
- Principal
Id string The Principal ID associated with this Managed Service Identity.
- Tenant
Id string The Tenant ID associated with this Managed Service Identity.
- Type string
Specifies the type of Managed Service Identity that should be configured on this Windows Web App. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- Identity
Ids []string A list of User Assigned Managed Identity IDs to be assigned to this Windows Web App.
- Principal
Id string The Principal ID associated with this Managed Service Identity.
- Tenant
Id string The Tenant ID associated with this Managed Service Identity.
- type String
Specifies the type of Managed Service Identity that should be configured on this Windows Web App. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- identity
Ids List<String> A list of User Assigned Managed Identity IDs to be assigned to this Windows Web App.
- principal
Id String The Principal ID associated with this Managed Service Identity.
- tenant
Id String The Tenant ID associated with this Managed Service Identity.
- type string
Specifies the type of Managed Service Identity that should be configured on this Windows Web App. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- identity
Ids string[] A list of User Assigned Managed Identity IDs to be assigned to this Windows Web App.
- principal
Id string The Principal ID associated with this Managed Service Identity.
- tenant
Id string The Tenant ID associated with this Managed Service Identity.
- type str
Specifies the type of Managed Service Identity that should be configured on this Windows 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).- identity
Ids List<String> A list of User Assigned Managed Identity IDs to be assigned to this Windows Web App.
- principal
Id String The Principal ID associated with this Managed Service Identity.
- tenant
Id String The Tenant ID associated with this Managed Service Identity.
WindowsWebAppLogs
- Application
Logs WindowsWeb App Logs Application Logs A
application_logs
block as defined above.- Detailed
Error boolMessages Should detailed error messages be enabled.
- Failed
Request boolTracing Should tracing be enabled for failed requests.
- Http
Logs WindowsWeb App Logs Http Logs A
http_logs
block as defined above.
- Application
Logs WindowsWeb App Logs Application Logs A
application_logs
block as defined above.- Detailed
Error boolMessages Should detailed error messages be enabled.
- Failed
Request boolTracing Should tracing be enabled for failed requests.
- Http
Logs WindowsWeb App Logs Http Logs A
http_logs
block as defined above.
- application
Logs WindowsWeb App Logs Application Logs A
application_logs
block as defined above.- detailed
Error BooleanMessages Should detailed error messages be enabled.
- failed
Request BooleanTracing Should tracing be enabled for failed requests.
- http
Logs WindowsWeb App Logs Http Logs A
http_logs
block as defined above.
- application
Logs WindowsWeb App Logs Application Logs A
application_logs
block as defined above.- detailed
Error booleanMessages Should detailed error messages be enabled.
- failed
Request booleanTracing Should tracing be enabled for failed requests.
- http
Logs WindowsWeb App Logs Http Logs A
http_logs
block as defined above.
- application_
logs WindowsWeb App Logs Application Logs A
application_logs
block as defined above.- detailed_
error_ boolmessages Should detailed error messages be enabled.
- failed_
request_ booltracing Should tracing be enabled for failed requests.
- http_
logs WindowsWeb App Logs Http Logs A
http_logs
block as defined above.
- application
Logs Property Map A
application_logs
block as defined above.- detailed
Error BooleanMessages Should detailed error messages be enabled.
- failed
Request BooleanTracing Should tracing be enabled for failed requests.
- http
Logs Property Map A
http_logs
block as defined above.
WindowsWebAppLogsApplicationLogs
- File
System stringLevel Log level. Possible values include:
Verbose
,Information
,Warning
, andError
.- Azure
Blob WindowsStorage Web App Logs Application Logs Azure Blob Storage An
azure_blob_storage
block as defined below.
- File
System stringLevel Log level. Possible values include:
Verbose
,Information
,Warning
, andError
.- Azure
Blob WindowsStorage Web App Logs Application Logs Azure Blob Storage An
azure_blob_storage
block as defined below.
- file
System StringLevel Log level. Possible values include:
Verbose
,Information
,Warning
, andError
.- azure
Blob WindowsStorage Web App Logs Application Logs Azure Blob Storage An
azure_blob_storage
block as defined below.
- file
System stringLevel Log level. Possible values include:
Verbose
,Information
,Warning
, andError
.- azure
Blob WindowsStorage Web App Logs Application Logs Azure Blob Storage An
azure_blob_storage
block as defined below.
- file_
system_ strlevel Log level. Possible values include:
Verbose
,Information
,Warning
, andError
.- azure_
blob_ Windowsstorage Web App Logs Application Logs Azure Blob Storage An
azure_blob_storage
block as defined below.
- file
System StringLevel Log level. Possible values include:
Verbose
,Information
,Warning
, andError
.- azure
Blob Property MapStorage An
azure_blob_storage
block as defined below.
WindowsWebAppLogsApplicationLogsAzureBlobStorage
- Level string
The level at which to log. Possible values include
Error
,Warning
,Information
,Verbose
andOff
. NOTE: this field is not available forhttp_logs
- Retention
In intDays The time in days after which to remove blobs. A value of
0
means no retention.- Sas
Url 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
andOff
. NOTE: this field is not available forhttp_logs
- Retention
In intDays The time in days after which to remove blobs. A value of
0
means no retention.- Sas
Url 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
andOff
. NOTE: this field is not available forhttp_logs
- retention
In IntegerDays The time in days after which to remove blobs. A value of
0
means no retention.- sas
Url 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
andOff
. NOTE: this field is not available forhttp_logs
- retention
In numberDays The time in days after which to remove blobs. A value of
0
means no retention.- sas
Url 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
andOff
. NOTE: this field is not available forhttp_logs
- retention_
in_ intdays 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
andOff
. NOTE: this field is not available forhttp_logs
- retention
In NumberDays The time in days after which to remove blobs. A value of
0
means no retention.- sas
Url String SAS url to an Azure blob container with read/write/list/delete permissions.
WindowsWebAppLogsHttpLogs
- Azure
Blob WindowsStorage Web App Logs Http Logs Azure Blob Storage A
azure_blob_storage_http
block as defined above.- File
System WindowsWeb App Logs Http Logs File System A
file_system
block as defined above.
- Azure
Blob WindowsStorage Web App Logs Http Logs Azure Blob Storage A
azure_blob_storage_http
block as defined above.- File
System WindowsWeb App Logs Http Logs File System A
file_system
block as defined above.
- azure
Blob WindowsStorage Web App Logs Http Logs Azure Blob Storage A
azure_blob_storage_http
block as defined above.- file
System WindowsWeb App Logs Http Logs File System A
file_system
block as defined above.
- azure
Blob WindowsStorage Web App Logs Http Logs Azure Blob Storage A
azure_blob_storage_http
block as defined above.- file
System WindowsWeb App Logs Http Logs File System A
file_system
block as defined above.
- azure_
blob_ Windowsstorage Web App Logs Http Logs Azure Blob Storage A
azure_blob_storage_http
block as defined above.- file_
system WindowsWeb App Logs Http Logs File System A
file_system
block as defined above.
- azure
Blob Property MapStorage A
azure_blob_storage_http
block as defined above.- file
System Property Map A
file_system
block as defined above.
WindowsWebAppLogsHttpLogsAzureBlobStorage
- Sas
Url string SAS url to an Azure blob container with read/write/list/delete permissions.
- Retention
In intDays The time in days after which to remove blobs. A value of
0
means no retention.
- Sas
Url string SAS url to an Azure blob container with read/write/list/delete permissions.
- Retention
In intDays The time in days after which to remove blobs. A value of
0
means no retention.
- sas
Url String SAS url to an Azure blob container with read/write/list/delete permissions.
- retention
In IntegerDays The time in days after which to remove blobs. A value of
0
means no retention.
- sas
Url string SAS url to an Azure blob container with read/write/list/delete permissions.
- retention
In numberDays 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_ intdays The time in days after which to remove blobs. A value of
0
means no retention.
- sas
Url String SAS url to an Azure blob container with read/write/list/delete permissions.
- retention
In NumberDays The time in days after which to remove blobs. A value of
0
means no retention.
WindowsWebAppLogsHttpLogsFileSystem
- Retention
In intDays The retention period in days. A values of
0
means no retention.- Retention
In intMb The maximum size in megabytes that log files can use.
- Retention
In intDays The retention period in days. A values of
0
means no retention.- Retention
In intMb The maximum size in megabytes that log files can use.
- retention
In IntegerDays The retention period in days. A values of
0
means no retention.- retention
In IntegerMb The maximum size in megabytes that log files can use.
- retention
In numberDays The retention period in days. A values of
0
means no retention.- retention
In numberMb The maximum size in megabytes that log files can use.
- retention_
in_ intdays The retention period in days. A values of
0
means no retention.- retention_
in_ intmb The maximum size in megabytes that log files can use.
- retention
In NumberDays The retention period in days. A values of
0
means no retention.- retention
In NumberMb The maximum size in megabytes that log files can use.
WindowsWebAppSiteConfig
- Always
On bool If this Windows Web App is Always On enabled. Defaults to
true
.- Api
Definition stringUrl The URL to the API Definition for this Windows Web App.
- Api
Management stringApi Id The API Management API ID this Windows Web App Slot is associated with.
- App
Command stringLine The App command line to launch.
- Application
Stack WindowsWeb App Site Config Application Stack A
application_stack
block as defined above.- Auto
Heal boolEnabled Should Auto heal rules be enabled. Required with
auto_heal_setting
.- Auto
Heal WindowsSetting Web App Site Config Auto Heal Setting A
auto_heal_setting
block as defined above. Required withauto_heal
.- Container
Registry stringManaged Identity Client Id The Client ID of the Managed Service Identity to use for connections to the Azure Container Registry.
- Container
Registry boolUse Managed Identity Should connections for Azure Container Registry use Managed Identity.
- Cors
Windows
Web App Site Config Cors A
cors
block as defined above.- Default
Documents List<string> Specifies a list of Default Documents for the Windows Web App.
- Detailed
Error boolLogging Enabled - Ftps
State string The State of FTP / FTPS service. Possible values include:
AllAllowed
,FtpsOnly
,Disabled
.- Health
Check intEviction Time In Min The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between
2
and10
. Only valid in conjunction withhealth_check_path
.- Health
Check stringPath The path to the Health Check.
- Http2Enabled bool
Should the HTTP2 be enabled?
- Ip
Restrictions List<WindowsWeb App Site Config Ip Restriction> One or more
ip_restriction
blocks as defined above.- Linux
Fx stringVersion - Load
Balancing stringMode The Site load balancing. Possible values include:
WeightedRoundRobin
,LeastRequests
,LeastResponseTime
,WeightedTotalTraffic
,RequestHash
,PerSiteRoundRobin
. Defaults toLeastRequests
if omitted.- Local
Mysql boolEnabled Use Local MySQL. Defaults to
false
.- Managed
Pipeline stringMode Managed pipeline mode. Possible values include:
Integrated
,Classic
.- Minimum
Tls stringVersion The configures the minimum version of TLS required for SSL requests. Possible values include:
1.0
,1.1
, and1.2
. Defaults to1.2
.- Remote
Debugging boolEnabled Should Remote Debugging be enabled. Defaults to
false
.- Remote
Debugging stringVersion The Remote Debugging Version. Possible values include
VS2017
andVS2019
- Scm
Ip List<WindowsRestrictions Web App Site Config Scm Ip Restriction> One or more
scm_ip_restriction
blocks as defined above.- Scm
Minimum stringTls Version The configures the minimum version of TLS required for SSL requests to the SCM site Possible values include:
1.0
,1.1
, and1.2
. Defaults to1.2
.- Scm
Type string - Scm
Use boolMain Ip Restriction Should the Windows Web App
ip_restriction
configuration be used for the SCM also.- Use32Bit
Worker bool Should the Windows Web App use a 32-bit worker. Defaults to
true
.- Virtual
Applications List<WindowsWeb App Site Config Virtual Application> One or more
virtual_application
blocks as defined below.- Vnet
Route boolAll Enabled Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to
false
.- Websockets
Enabled bool Should Web Sockets be enabled. Defaults to
false
.- Windows
Fx stringVersion - Worker
Count int 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 stringUrl The URL to the API Definition for this Windows Web App.
- Api
Management stringApi Id The API Management API ID this Windows Web App Slot is associated with.
- App
Command stringLine The App command line to launch.
- Application
Stack WindowsWeb App Site Config Application Stack A
application_stack
block as defined above.- Auto
Heal boolEnabled Should Auto heal rules be enabled. Required with
auto_heal_setting
.- Auto
Heal WindowsSetting Web App Site Config Auto Heal Setting A
auto_heal_setting
block as defined above. Required withauto_heal
.- Container
Registry stringManaged Identity Client Id The Client ID of the Managed Service Identity to use for connections to the Azure Container Registry.
- Container
Registry boolUse Managed Identity Should connections for Azure Container Registry use Managed Identity.
- Cors
Windows
Web App Site Config Cors A
cors
block as defined above.- Default
Documents []string Specifies a list of Default Documents for the Windows Web App.
- Detailed
Error boolLogging Enabled - Ftps
State string The State of FTP / FTPS service. Possible values include:
AllAllowed
,FtpsOnly
,Disabled
.- Health
Check intEviction Time In Min The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between
2
and10
. Only valid in conjunction withhealth_check_path
.- Health
Check stringPath The path to the Health Check.
- Http2Enabled bool
Should the HTTP2 be enabled?
- Ip
Restrictions []WindowsWeb App Site Config Ip Restriction One or more
ip_restriction
blocks as defined above.- Linux
Fx stringVersion - Load
Balancing stringMode The Site load balancing. Possible values include:
WeightedRoundRobin
,LeastRequests
,LeastResponseTime
,WeightedTotalTraffic
,RequestHash
,PerSiteRoundRobin
. Defaults toLeastRequests
if omitted.- Local
Mysql boolEnabled Use Local MySQL. Defaults to
false
.- Managed
Pipeline stringMode Managed pipeline mode. Possible values include:
Integrated
,Classic
.- Minimum
Tls stringVersion The configures the minimum version of TLS required for SSL requests. Possible values include:
1.0
,1.1
, and1.2
. Defaults to1.2
.- Remote
Debugging boolEnabled Should Remote Debugging be enabled. Defaults to
false
.- Remote
Debugging stringVersion The Remote Debugging Version. Possible values include
VS2017
andVS2019
- Scm
Ip []WindowsRestrictions Web App Site Config Scm Ip Restriction One or more
scm_ip_restriction
blocks as defined above.- Scm
Minimum stringTls Version The configures the minimum version of TLS required for SSL requests to the SCM site Possible values include:
1.0
,1.1
, and1.2
. Defaults to1.2
.- Scm
Type string - Scm
Use boolMain Ip Restriction Should the Windows Web App
ip_restriction
configuration be used for the SCM also.- Use32Bit
Worker bool Should the Windows Web App use a 32-bit worker. Defaults to
true
.- Virtual
Applications []WindowsWeb App Site Config Virtual Application One or more
virtual_application
blocks as defined below.- Vnet
Route boolAll Enabled Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to
false
.- Websockets
Enabled bool Should Web Sockets be enabled. Defaults to
false
.- Windows
Fx stringVersion - Worker
Count int The number of Workers for this Windows App Service.
- always
On Boolean If this Windows Web App is Always On enabled. Defaults to
true
.- api
Definition StringUrl The URL to the API Definition for this Windows Web App.
- api
Management StringApi Id The API Management API ID this Windows Web App Slot is associated with.
- app
Command StringLine The App command line to launch.
- application
Stack WindowsWeb App Site Config Application Stack A
application_stack
block as defined above.- auto
Heal BooleanEnabled Should Auto heal rules be enabled. Required with
auto_heal_setting
.- auto
Heal WindowsSetting Web App Site Config Auto Heal Setting A
auto_heal_setting
block as defined above. Required withauto_heal
.- container
Registry StringManaged Identity Client Id The Client ID of the Managed Service Identity to use for connections to the Azure Container Registry.
- container
Registry BooleanUse Managed Identity Should connections for Azure Container Registry use Managed Identity.
- cors
Windows
Web App Site Config Cors A
cors
block as defined above.- default
Documents List<String> Specifies a list of Default Documents for the Windows Web App.
- detailed
Error BooleanLogging Enabled - ftps
State String The State of FTP / FTPS service. Possible values include:
AllAllowed
,FtpsOnly
,Disabled
.- health
Check IntegerEviction Time In Min The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between
2
and10
. Only valid in conjunction withhealth_check_path
.- health
Check StringPath The path to the Health Check.
- http2Enabled Boolean
Should the HTTP2 be enabled?
- ip
Restrictions List<WindowsWeb App Site Config Ip Restriction> One or more
ip_restriction
blocks as defined above.- linux
Fx StringVersion - load
Balancing StringMode The Site load balancing. Possible values include:
WeightedRoundRobin
,LeastRequests
,LeastResponseTime
,WeightedTotalTraffic
,RequestHash
,PerSiteRoundRobin
. Defaults toLeastRequests
if omitted.- local
Mysql BooleanEnabled Use Local MySQL. Defaults to
false
.- managed
Pipeline StringMode Managed pipeline mode. Possible values include:
Integrated
,Classic
.- minimum
Tls StringVersion The configures the minimum version of TLS required for SSL requests. Possible values include:
1.0
,1.1
, and1.2
. Defaults to1.2
.- remote
Debugging BooleanEnabled Should Remote Debugging be enabled. Defaults to
false
.- remote
Debugging StringVersion The Remote Debugging Version. Possible values include
VS2017
andVS2019
- scm
Ip List<WindowsRestrictions Web App Site Config Scm Ip Restriction> One or more
scm_ip_restriction
blocks as defined above.- scm
Minimum StringTls Version The configures the minimum version of TLS required for SSL requests to the SCM site Possible values include:
1.0
,1.1
, and1.2
. Defaults to1.2
.- scm
Type String - scm
Use BooleanMain Ip Restriction Should the Windows Web App
ip_restriction
configuration be used for the SCM also.- use32Bit
Worker Boolean Should the Windows Web App use a 32-bit worker. Defaults to
true
.- virtual
Applications List<WindowsWeb App Site Config Virtual Application> One or more
virtual_application
blocks as defined below.- vnet
Route BooleanAll Enabled Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to
false
.- websockets
Enabled Boolean Should Web Sockets be enabled. Defaults to
false
.- windows
Fx StringVersion - worker
Count Integer The number of Workers for this Windows App Service.
- always
On boolean If this Windows Web App is Always On enabled. Defaults to
true
.- api
Definition stringUrl The URL to the API Definition for this Windows Web App.
- api
Management stringApi Id The API Management API ID this Windows Web App Slot is associated with.
- app
Command stringLine The App command line to launch.
- application
Stack WindowsWeb App Site Config Application Stack A
application_stack
block as defined above.- auto
Heal booleanEnabled Should Auto heal rules be enabled. Required with
auto_heal_setting
.- auto
Heal WindowsSetting Web App Site Config Auto Heal Setting A
auto_heal_setting
block as defined above. Required withauto_heal
.- container
Registry stringManaged Identity Client Id The Client ID of the Managed Service Identity to use for connections to the Azure Container Registry.
- container
Registry booleanUse Managed Identity Should connections for Azure Container Registry use Managed Identity.
- cors
Windows
Web App Site Config Cors A
cors
block as defined above.- default
Documents string[] Specifies a list of Default Documents for the Windows Web App.
- detailed
Error booleanLogging Enabled - ftps
State string The State of FTP / FTPS service. Possible values include:
AllAllowed
,FtpsOnly
,Disabled
.- health
Check numberEviction Time In Min The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between
2
and10
. Only valid in conjunction withhealth_check_path
.- health
Check stringPath The path to the Health Check.
- http2Enabled boolean
Should the HTTP2 be enabled?
- ip
Restrictions WindowsWeb App Site Config Ip Restriction[] One or more
ip_restriction
blocks as defined above.- linux
Fx stringVersion - load
Balancing stringMode The Site load balancing. Possible values include:
WeightedRoundRobin
,LeastRequests
,LeastResponseTime
,WeightedTotalTraffic
,RequestHash
,PerSiteRoundRobin
. Defaults toLeastRequests
if omitted.- local
Mysql booleanEnabled Use Local MySQL. Defaults to
false
.- managed
Pipeline stringMode Managed pipeline mode. Possible values include:
Integrated
,Classic
.- minimum
Tls stringVersion The configures the minimum version of TLS required for SSL requests. Possible values include:
1.0
,1.1
, and1.2
. Defaults to1.2
.- remote
Debugging booleanEnabled Should Remote Debugging be enabled. Defaults to
false
.- remote
Debugging stringVersion The Remote Debugging Version. Possible values include
VS2017
andVS2019
- scm
Ip WindowsRestrictions Web App Site Config Scm Ip Restriction[] One or more
scm_ip_restriction
blocks as defined above.- scm
Minimum stringTls Version The configures the minimum version of TLS required for SSL requests to the SCM site Possible values include:
1.0
,1.1
, and1.2
. Defaults to1.2
.- scm
Type string - scm
Use booleanMain Ip Restriction Should the Windows Web App
ip_restriction
configuration be used for the SCM also.- use32Bit
Worker boolean Should the Windows Web App use a 32-bit worker. Defaults to
true
.- virtual
Applications WindowsWeb App Site Config Virtual Application[] One or more
virtual_application
blocks as defined below.- vnet
Route booleanAll Enabled Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to
false
.- websockets
Enabled boolean Should Web Sockets be enabled. Defaults to
false
.- windows
Fx stringVersion - worker
Count 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_ strurl The URL to the API Definition for this Windows Web App.
- api_
management_ strapi_ id The API Management API ID this Windows Web App Slot is associated with.
- app_
command_ strline The App command line to launch.
- application_
stack WindowsWeb App Site Config Application Stack A
application_stack
block as defined above.- auto_
heal_ boolenabled Should Auto heal rules be enabled. Required with
auto_heal_setting
.- auto_
heal_ Windowssetting Web App Site Config Auto Heal Setting A
auto_heal_setting
block as defined above. Required withauto_heal
.- container_
registry_ strmanaged_ identity_ client_ id The Client ID of the Managed Service Identity to use for connections to the Azure Container Registry.
- container_
registry_ booluse_ managed_ identity Should connections for Azure Container Registry use Managed Identity.
- cors
Windows
Web App Site Config Cors A
cors
block as defined above.- default_
documents Sequence[str] Specifies a list of Default Documents for the Windows Web App.
- detailed_
error_ boollogging_ enabled - ftps_
state str The State of FTP / FTPS service. Possible values include:
AllAllowed
,FtpsOnly
,Disabled
.- health_
check_ inteviction_ time_ in_ min The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between
2
and10
. Only valid in conjunction withhealth_check_path
.- health_
check_ strpath The path to the Health Check.
- http2_
enabled bool Should the HTTP2 be enabled?
- ip_
restrictions Sequence[WindowsWeb App Site Config Ip Restriction] One or more
ip_restriction
blocks as defined above.- linux_
fx_ strversion - load_
balancing_ strmode The Site load balancing. Possible values include:
WeightedRoundRobin
,LeastRequests
,LeastResponseTime
,WeightedTotalTraffic
,RequestHash
,PerSiteRoundRobin
. Defaults toLeastRequests
if omitted.- local_
mysql_ boolenabled Use Local MySQL. Defaults to
false
.- managed_
pipeline_ strmode Managed pipeline mode. Possible values include:
Integrated
,Classic
.- minimum_
tls_ strversion The configures the minimum version of TLS required for SSL requests. Possible values include:
1.0
,1.1
, and1.2
. Defaults to1.2
.- remote_
debugging_ boolenabled Should Remote Debugging be enabled. Defaults to
false
.- remote_
debugging_ strversion The Remote Debugging Version. Possible values include
VS2017
andVS2019
- scm_
ip_ Sequence[Windowsrestrictions Web App Site Config Scm Ip Restriction] One or more
scm_ip_restriction
blocks as defined above.- scm_
minimum_ strtls_ version The configures the minimum version of TLS required for SSL requests to the SCM site Possible values include:
1.0
,1.1
, and1.2
. Defaults to1.2
.- scm_
type str - scm_
use_ boolmain_ ip_ restriction Should the Windows Web App
ip_restriction
configuration be used for the SCM also.- use32_
bit_ boolworker Should the Windows Web App use a 32-bit worker. Defaults to
true
.- virtual_
applications Sequence[WindowsWeb App Site Config Virtual Application] One or more
virtual_application
blocks as defined below.- vnet_
route_ boolall_ enabled Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to
false
.- websockets_
enabled bool Should Web Sockets be enabled. Defaults to
false
.- windows_
fx_ strversion - worker_
count int The number of Workers for this Windows App Service.
- always
On Boolean If this Windows Web App is Always On enabled. Defaults to
true
.- api
Definition StringUrl The URL to the API Definition for this Windows Web App.
- api
Management StringApi Id The API Management API ID this Windows Web App Slot is associated with.
- app
Command StringLine The App command line to launch.
- application
Stack Property Map A
application_stack
block as defined above.- auto
Heal BooleanEnabled Should Auto heal rules be enabled. Required with
auto_heal_setting
.- auto
Heal Property MapSetting A
auto_heal_setting
block as defined above. Required withauto_heal
.- container
Registry StringManaged Identity Client Id The Client ID of the Managed Service Identity to use for connections to the Azure Container Registry.
- container
Registry BooleanUse Managed Identity Should connections for Azure Container Registry use Managed Identity.
- cors Property Map
A
cors
block as defined above.- default
Documents List<String> Specifies a list of Default Documents for the Windows Web App.
- detailed
Error BooleanLogging Enabled - ftps
State String The State of FTP / FTPS service. Possible values include:
AllAllowed
,FtpsOnly
,Disabled
.- health
Check NumberEviction Time In Min The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between
2
and10
. Only valid in conjunction withhealth_check_path
.- health
Check StringPath The path to the Health Check.
- http2Enabled Boolean
Should the HTTP2 be enabled?
- ip
Restrictions List<Property Map> One or more
ip_restriction
blocks as defined above.- linux
Fx StringVersion - load
Balancing StringMode The Site load balancing. Possible values include:
WeightedRoundRobin
,LeastRequests
,LeastResponseTime
,WeightedTotalTraffic
,RequestHash
,PerSiteRoundRobin
. Defaults toLeastRequests
if omitted.- local
Mysql BooleanEnabled Use Local MySQL. Defaults to
false
.- managed
Pipeline StringMode Managed pipeline mode. Possible values include:
Integrated
,Classic
.- minimum
Tls StringVersion The configures the minimum version of TLS required for SSL requests. Possible values include:
1.0
,1.1
, and1.2
. Defaults to1.2
.- remote
Debugging BooleanEnabled Should Remote Debugging be enabled. Defaults to
false
.- remote
Debugging StringVersion The Remote Debugging Version. Possible values include
VS2017
andVS2019
- scm
Ip List<Property Map>Restrictions One or more
scm_ip_restriction
blocks as defined above.- scm
Minimum StringTls Version The configures the minimum version of TLS required for SSL requests to the SCM site Possible values include:
1.0
,1.1
, and1.2
. Defaults to1.2
.- scm
Type String - scm
Use BooleanMain Ip Restriction Should the Windows Web App
ip_restriction
configuration be used for the SCM also.- use32Bit
Worker Boolean Should the Windows Web App use a 32-bit worker. Defaults to
true
.- virtual
Applications List<Property Map> One or more
virtual_application
blocks as defined below.- vnet
Route BooleanAll Enabled Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to
false
.- websockets
Enabled Boolean Should Web Sockets be enabled. Defaults to
false
.- windows
Fx StringVersion - worker
Count Number The number of Workers for this Windows App Service.
WindowsWebAppSiteConfigApplicationStack
- Current
Stack string The Application Stack for the Windows Web App. Possible values include
dotnet
,dotnetcore
,node
,python
,php
, andjava
.- Docker
Container stringName The name of the Docker Container. For example
azure-app-service/samples/aspnethelloworld
- Docker
Container stringRegistry The registry Host on which the specified Docker Container can be located. For example
mcr.microsoft.com
- Docker
Container stringTag The Image Tag of the specified Docker Container to use. For example
latest
- Dotnet
Core stringVersion The version of .NET to use when
current_stack
is set todotnetcore
. Possible values includev4.0
.- Dotnet
Version string The version of .NET to use when
current_stack
is set todotnet
. Possible values includev2.0
,v3.0
,v4.0
,v5.0
,v6.0
andv7.0
.- Java
Container string this property has been deprecated in favour of
tomcat_version
andjava_embedded_server_enabled
- Java
Container stringVersion This property has been deprecated in favour of
tomcat_version
andjava_embedded_server_enabled
- Java
Embedded boolServer Enabled Should the Java Embedded Server (Java SE) be used to run the app.
- Java
Version string The version of Java to use when
current_stack
is set tojava
.- Node
Version string The version of node to use when
current_stack
is set tonode
. Possible values are~12
,~14
,~16
, and~18
.- Php
Version string The version of PHP to use when
current_stack
is set tophp
. Possible values are7.1
,7.4
andOff
.- Python bool
Specifies whether this is a Python app. Defaults to
false
.- Python
Version string This property is deprecated. Values set are not used by the service.
- Tomcat
Version string The version of Tomcat the Java App should use. Conflicts with
java_embedded_server_enabled
- Current
Stack string The Application Stack for the Windows Web App. Possible values include
dotnet
,dotnetcore
,node
,python
,php
, andjava
.- Docker
Container stringName The name of the Docker Container. For example
azure-app-service/samples/aspnethelloworld
- Docker
Container stringRegistry The registry Host on which the specified Docker Container can be located. For example
mcr.microsoft.com
- Docker
Container stringTag The Image Tag of the specified Docker Container to use. For example
latest
- Dotnet
Core stringVersion The version of .NET to use when
current_stack
is set todotnetcore
. Possible values includev4.0
.- Dotnet
Version string The version of .NET to use when
current_stack
is set todotnet
. Possible values includev2.0
,v3.0
,v4.0
,v5.0
,v6.0
andv7.0
.- Java
Container string this property has been deprecated in favour of
tomcat_version
andjava_embedded_server_enabled
- Java
Container stringVersion This property has been deprecated in favour of
tomcat_version
andjava_embedded_server_enabled
- Java
Embedded boolServer Enabled Should the Java Embedded Server (Java SE) be used to run the app.
- Java
Version string The version of Java to use when
current_stack
is set tojava
.- Node
Version string The version of node to use when
current_stack
is set tonode
. Possible values are~12
,~14
,~16
, and~18
.- Php
Version string The version of PHP to use when
current_stack
is set tophp
. Possible values are7.1
,7.4
andOff
.- Python bool
Specifies whether this is a Python app. Defaults to
false
.- Python
Version string This property is deprecated. Values set are not used by the service.
- Tomcat
Version string The version of Tomcat the Java App should use. Conflicts with
java_embedded_server_enabled
- current
Stack String The Application Stack for the Windows Web App. Possible values include
dotnet
,dotnetcore
,node
,python
,php
, andjava
.- docker
Container StringName The name of the Docker Container. For example
azure-app-service/samples/aspnethelloworld
- docker
Container StringRegistry The registry Host on which the specified Docker Container can be located. For example
mcr.microsoft.com
- docker
Container StringTag The Image Tag of the specified Docker Container to use. For example
latest
- dotnet
Core StringVersion The version of .NET to use when
current_stack
is set todotnetcore
. Possible values includev4.0
.- dotnet
Version String The version of .NET to use when
current_stack
is set todotnet
. Possible values includev2.0
,v3.0
,v4.0
,v5.0
,v6.0
andv7.0
.- java
Container String this property has been deprecated in favour of
tomcat_version
andjava_embedded_server_enabled
- java
Container StringVersion This property has been deprecated in favour of
tomcat_version
andjava_embedded_server_enabled
- java
Embedded BooleanServer Enabled Should the Java Embedded Server (Java SE) be used to run the app.
- java
Version String The version of Java to use when
current_stack
is set tojava
.- node
Version String The version of node to use when
current_stack
is set tonode
. Possible values are~12
,~14
,~16
, and~18
.- php
Version String The version of PHP to use when
current_stack
is set tophp
. Possible values are7.1
,7.4
andOff
.- python Boolean
Specifies whether this is a Python app. Defaults to
false
.- python
Version String This property is deprecated. Values set are not used by the service.
- tomcat
Version String The version of Tomcat the Java App should use. Conflicts with
java_embedded_server_enabled
- current
Stack string The Application Stack for the Windows Web App. Possible values include
dotnet
,dotnetcore
,node
,python
,php
, andjava
.- docker
Container stringName The name of the Docker Container. For example
azure-app-service/samples/aspnethelloworld
- docker
Container stringRegistry The registry Host on which the specified Docker Container can be located. For example
mcr.microsoft.com
- docker
Container stringTag The Image Tag of the specified Docker Container to use. For example
latest
- dotnet
Core stringVersion The version of .NET to use when
current_stack
is set todotnetcore
. Possible values includev4.0
.- dotnet
Version string The version of .NET to use when
current_stack
is set todotnet
. Possible values includev2.0
,v3.0
,v4.0
,v5.0
,v6.0
andv7.0
.- java
Container string this property has been deprecated in favour of
tomcat_version
andjava_embedded_server_enabled
- java
Container stringVersion This property has been deprecated in favour of
tomcat_version
andjava_embedded_server_enabled
- java
Embedded booleanServer Enabled Should the Java Embedded Server (Java SE) be used to run the app.
- java
Version string The version of Java to use when
current_stack
is set tojava
.- node
Version string The version of node to use when
current_stack
is set tonode
. Possible values are~12
,~14
,~16
, and~18
.- php
Version string The version of PHP to use when
current_stack
is set tophp
. Possible values are7.1
,7.4
andOff
.- python boolean
Specifies whether this is a Python app. Defaults to
false
.- python
Version string This property is deprecated. Values set are not used by the service.
- tomcat
Version 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
, andjava
.- docker_
container_ strname The name of the Docker Container. For example
azure-app-service/samples/aspnethelloworld
- docker_
container_ strregistry The registry Host on which the specified Docker Container can be located. For example
mcr.microsoft.com
- docker_
container_ strtag The Image Tag of the specified Docker Container to use. For example
latest
- dotnet_
core_ strversion The version of .NET to use when
current_stack
is set todotnetcore
. Possible values includev4.0
.- dotnet_
version str The version of .NET to use when
current_stack
is set todotnet
. Possible values includev2.0
,v3.0
,v4.0
,v5.0
,v6.0
andv7.0
.- java_
container str this property has been deprecated in favour of
tomcat_version
andjava_embedded_server_enabled
- java_
container_ strversion This property has been deprecated in favour of
tomcat_version
andjava_embedded_server_enabled
- java_
embedded_ boolserver_ enabled 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 tojava
.- node_
version str The version of node to use when
current_stack
is set tonode
. Possible values are~12
,~14
,~16
, and~18
.- php_
version str The version of PHP to use when
current_stack
is set tophp
. Possible values are7.1
,7.4
andOff
.- python bool
Specifies whether this is a Python app. Defaults to
false
.- python_
version str 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
- current
Stack String The Application Stack for the Windows Web App. Possible values include
dotnet
,dotnetcore
,node
,python
,php
, andjava
.- docker
Container StringName The name of the Docker Container. For example
azure-app-service/samples/aspnethelloworld
- docker
Container StringRegistry The registry Host on which the specified Docker Container can be located. For example
mcr.microsoft.com
- docker
Container StringTag The Image Tag of the specified Docker Container to use. For example
latest
- dotnet
Core StringVersion The version of .NET to use when
current_stack
is set todotnetcore
. Possible values includev4.0
.- dotnet
Version String The version of .NET to use when
current_stack
is set todotnet
. Possible values includev2.0
,v3.0
,v4.0
,v5.0
,v6.0
andv7.0
.- java
Container String this property has been deprecated in favour of
tomcat_version
andjava_embedded_server_enabled
- java
Container StringVersion This property has been deprecated in favour of
tomcat_version
andjava_embedded_server_enabled
- java
Embedded BooleanServer Enabled Should the Java Embedded Server (Java SE) be used to run the app.
- java
Version String The version of Java to use when
current_stack
is set tojava
.- node
Version String The version of node to use when
current_stack
is set tonode
. Possible values are~12
,~14
,~16
, and~18
.- php
Version String The version of PHP to use when
current_stack
is set tophp
. Possible values are7.1
,7.4
andOff
.- python Boolean
Specifies whether this is a Python app. Defaults to
false
.- python
Version String This property is deprecated. Values set are not used by the service.
- tomcat
Version String The version of Tomcat the Java App should use. Conflicts with
java_embedded_server_enabled
WindowsWebAppSiteConfigAutoHealSetting
- Action
Windows
Web App Site Config Auto Heal Setting Action An
action
block as defined above.- Trigger
Windows
Web App Site Config Auto Heal Setting Trigger A
trigger
block as defined below.
- Action
Windows
Web App Site Config Auto Heal Setting Action An
action
block as defined above.- Trigger
Windows
Web App Site Config Auto Heal Setting Trigger A
trigger
block as defined below.
- action
Windows
Web App Site Config Auto Heal Setting Action An
action
block as defined above.- trigger
Windows
Web App Site Config Auto Heal Setting Trigger A
trigger
block as defined below.
- action
Windows
Web App Site Config Auto Heal Setting Action An
action
block as defined above.- trigger
Windows
Web App Site Config Auto Heal Setting Trigger A
trigger
block as defined below.
- action
Windows
Web App Site Config Auto Heal Setting Action An
action
block as defined above.- trigger
Windows
Web App Site Config Auto Heal Setting Trigger 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
- Action
Type string Predefined action to be taken to an Auto Heal trigger. Possible values include:
Recycle
,LogEvent
, andCustomAction
.- Custom
Action WindowsWeb App Site Config Auto Heal Setting Action Custom Action A
custom_action
block as defined below.- Minimum
Process stringExecution Time 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 string Predefined action to be taken to an Auto Heal trigger. Possible values include:
Recycle
,LogEvent
, andCustomAction
.- Custom
Action WindowsWeb App Site Config Auto Heal Setting Action Custom Action A
custom_action
block as defined below.- Minimum
Process stringExecution Time 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 String Predefined action to be taken to an Auto Heal trigger. Possible values include:
Recycle
,LogEvent
, andCustomAction
.- custom
Action WindowsWeb App Site Config Auto Heal Setting Action Custom Action A
custom_action
block as defined below.- minimum
Process StringExecution Time 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 string Predefined action to be taken to an Auto Heal trigger. Possible values include:
Recycle
,LogEvent
, andCustomAction
.- custom
Action WindowsWeb App Site Config Auto Heal Setting Action Custom Action A
custom_action
block as defined below.- minimum
Process stringExecution Time 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
, andCustomAction
.- custom_
action WindowsWeb App Site Config Auto Heal Setting Action Custom Action A
custom_action
block as defined below.- minimum_
process_ strexecution_ time 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 String Predefined action to be taken to an Auto Heal trigger. Possible values include:
Recycle
,LogEvent
, andCustomAction
.- custom
Action Property Map A
custom_action
block as defined below.- minimum
Process StringExecution Time 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
- Private
Memory intKb The amount of Private Memory to be consumed for this rule to trigger. Possible values are between
102400
and13631488
.- Requests
Windows
Web App Site Config Auto Heal Setting Trigger Requests A
requests
block as defined above.- Slow
Requests List<WindowsWeb App Site Config Auto Heal Setting Trigger Slow Request> One or more
slow_request
blocks as defined above.- Status
Codes List<WindowsWeb App Site Config Auto Heal Setting Trigger Status Code> One or more
status_code
blocks as defined above.
- Private
Memory intKb The amount of Private Memory to be consumed for this rule to trigger. Possible values are between
102400
and13631488
.- Requests
Windows
Web App Site Config Auto Heal Setting Trigger Requests A
requests
block as defined above.- Slow
Requests []WindowsWeb App Site Config Auto Heal Setting Trigger Slow Request One or more
slow_request
blocks as defined above.- Status
Codes []WindowsWeb App Site Config Auto Heal Setting Trigger Status Code One or more
status_code
blocks as defined above.
- private
Memory IntegerKb The amount of Private Memory to be consumed for this rule to trigger. Possible values are between
102400
and13631488
.- requests
Windows
Web App Site Config Auto Heal Setting Trigger Requests A
requests
block as defined above.- slow
Requests List<WindowsWeb App Site Config Auto Heal Setting Trigger Slow Request> One or more
slow_request
blocks as defined above.- status
Codes List<WindowsWeb App Site Config Auto Heal Setting Trigger Status Code> One or more
status_code
blocks as defined above.
- private
Memory numberKb The amount of Private Memory to be consumed for this rule to trigger. Possible values are between
102400
and13631488
.- requests
Windows
Web App Site Config Auto Heal Setting Trigger Requests A
requests
block as defined above.- slow
Requests WindowsWeb App Site Config Auto Heal Setting Trigger Slow Request[] One or more
slow_request
blocks as defined above.- status
Codes WindowsWeb App Site Config Auto Heal Setting Trigger Status Code[] One or more
status_code
blocks as defined above.
- private_
memory_ intkb The amount of Private Memory to be consumed for this rule to trigger. Possible values are between
102400
and13631488
.- requests
Windows
Web App Site Config Auto Heal Setting Trigger Requests A
requests
block as defined above.- slow_
requests Sequence[WindowsWeb App Site Config Auto Heal Setting Trigger Slow Request] One or more
slow_request
blocks as defined above.- status_
codes Sequence[WindowsWeb App Site Config Auto Heal Setting Trigger Status Code] One or more
status_code
blocks as defined above.
- private
Memory NumberKb The amount of Private Memory to be consumed for this rule to trigger. Possible values are between
102400
and13631488
.- requests Property Map
A
requests
block as defined above.- slow
Requests List<Property Map> One or more
slow_request
blocks as defined above.- status
Codes List<Property Map> One or more
status_code
blocks as defined above.
WindowsWebAppSiteConfigAutoHealSettingTriggerRequests
WindowsWebAppSiteConfigAutoHealSettingTriggerSlowRequest
- 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.
WindowsWebAppSiteConfigAutoHealSettingTriggerStatusCode
- Count int
The number of occurrences of the defined
status_code
in the specifiedinterval
on which to trigger this rule.- Interval string
The time interval in the form
hh:mm:ss
.- Status
Code stringRange The status code for this rule, accepts single status codes and status code ranges. e.g.
500
or400-499
. Possible values are integers between101
and599
- Path string
The path to which this rule status code applies.
- Sub
Status 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 specifiedinterval
on which to trigger this rule.- Interval string
The time interval in the form
hh:mm:ss
.- Status
Code stringRange The status code for this rule, accepts single status codes and status code ranges. e.g.
500
or400-499
. Possible values are integers between101
and599
- Path string
The path to which this rule status code applies.
- Sub
Status 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 specifiedinterval
on which to trigger this rule.- interval String
The time interval in the form
hh:mm:ss
.- status
Code StringRange The status code for this rule, accepts single status codes and status code ranges. e.g.
500
or400-499
. Possible values are integers between101
and599
- path String
The path to which this rule status code applies.
- sub
Status 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 specifiedinterval
on which to trigger this rule.- interval string
The time interval in the form
hh:mm:ss
.- status
Code stringRange The status code for this rule, accepts single status codes and status code ranges. e.g.
500
or400-499
. Possible values are integers between101
and599
- path string
The path to which this rule status code applies.
- sub
Status 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 specifiedinterval
on which to trigger this rule.- interval str
The time interval in the form
hh:mm:ss
.- status_
code_ strrange The status code for this rule, accepts single status codes and status code ranges. e.g.
500
or400-499
. Possible values are integers between101
and599
- 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 specifiedinterval
on which to trigger this rule.- interval String
The time interval in the form
hh:mm:ss
.- status
Code StringRange The status code for this rule, accepts single status codes and status code ranges. e.g.
500
or400-499
. Possible values are integers between101
and599
- path String
The path to which this rule status code applies.
- sub
Status Number The Request Sub Status of the Status Code.
- win32Status String
The Win32 Status Code of the Request.
WindowsWebAppSiteConfigCors
- Allowed
Origins List<string> 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
- Allowed
Origins []string 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
- allowed
Origins List<String> Specifies a list of origins that should be allowed to make cross-origin calls.
- support
Credentials Boolean Whether CORS requests with credentials are allowed. Defaults to
false
- allowed
Origins string[] Specifies a list of origins that should be allowed to make cross-origin calls.
- support
Credentials 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
- allowed
Origins List<String> Specifies a list of origins that should be allowed to make cross-origin calls.
- support
Credentials Boolean Whether CORS requests with credentials are allowed. Defaults to
false
WindowsWebAppSiteConfigIpRestriction
- Action string
The action to take. Possible values are
Allow
orDeny
.- Headers
Windows
Web App Site Config Ip Restriction Headers A
headers
block as defined above.- Ip
Address string The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24
or192.168.10.1/32
- Name string
The name which should be used for this
ip_restriction
.- Priority int
The priority value of this
ip_restriction
. Defaults to65000
.- Service
Tag string The Service Tag used for this IP Restriction.
- Virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
- Action string
The action to take. Possible values are
Allow
orDeny
.- Headers
Windows
Web App Site Config Ip Restriction Headers A
headers
block as defined above.- Ip
Address string The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24
or192.168.10.1/32
- Name string
The name which should be used for this
ip_restriction
.- Priority int
The priority value of this
ip_restriction
. Defaults to65000
.- Service
Tag string The Service Tag used for this IP Restriction.
- Virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
- action String
The action to take. Possible values are
Allow
orDeny
.- headers
Windows
Web App Site Config Ip Restriction Headers A
headers
block as defined above.- ip
Address String The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24
or192.168.10.1/32
- name String
The name which should be used for this
ip_restriction
.- priority Integer
The priority value of this
ip_restriction
. Defaults to65000
.- service
Tag String The Service Tag used for this IP Restriction.
- virtual
Network StringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
- action string
The action to take. Possible values are
Allow
orDeny
.- headers
Windows
Web App Site Config Ip Restriction Headers A
headers
block as defined above.- ip
Address string The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24
or192.168.10.1/32
- name string
The name which should be used for this
ip_restriction
.- priority number
The priority value of this
ip_restriction
. Defaults to65000
.- service
Tag string The Service Tag used for this IP Restriction.
- virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
- action str
The action to take. Possible values are
Allow
orDeny
.- headers
Windows
Web App Site Config Ip Restriction Headers 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
or192.168.10.1/32
- name str
The name which should be used for this
ip_restriction
.- priority int
The priority value of this
ip_restriction
. Defaults to65000
.- service_
tag str The Service Tag used for this IP Restriction.
- virtual_
network_ strsubnet_ id The Virtual Network Subnet ID used for this IP Restriction.
- action String
The action to take. Possible values are
Allow
orDeny
.- headers Property Map
A
headers
block as defined above.- ip
Address String The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24
or192.168.10.1/32
- name String
The name which should be used for this
ip_restriction
.- priority Number
The priority value of this
ip_restriction
. Defaults to65000
.- service
Tag String The Service Tag used for this IP Restriction.
- virtual
Network StringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
WindowsWebAppSiteConfigIpRestrictionHeaders
- XAzure
Fdids List<string> Specifies a list of Azure Front Door IDs.
- XFd
Health stringProbe Specifies if a Front Door Health Probe should be expected. The only possible value is
1
.- XForwarded
Fors List<string> Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- XForwarded
Hosts List<string> Specifies a list of Hosts for which matching should be applied.
- XAzure
Fdids []string Specifies a list of Azure Front Door IDs.
- XFd
Health stringProbe Specifies if a Front Door Health Probe should be expected. The only possible value is
1
.- XForwarded
Fors []string Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- XForwarded
Hosts []string Specifies a list of Hosts for which matching should be applied.
- x
Azure List<String>Fdids Specifies a list of Azure Front Door IDs.
- x
Fd StringHealth Probe Specifies if a Front Door Health Probe should be expected. The only possible value is
1
.- x
Forwarded List<String>Fors Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- x
Forwarded List<String>Hosts Specifies a list of Hosts for which matching should be applied.
- x
Azure string[]Fdids Specifies a list of Azure Front Door IDs.
- x
Fd stringHealth Probe Specifies if a Front Door Health Probe should be expected. The only possible value is
1
.- x
Forwarded string[]Fors Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- x
Forwarded string[]Hosts Specifies a list of Hosts for which matching should be applied.
- x_
azure_ Sequence[str]fdids Specifies a list of Azure Front Door IDs.
- x_
fd_ strhealth_ probe Specifies if a Front Door Health Probe should be expected. The only possible value is
1
.- x_
forwarded_ Sequence[str]fors Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- x_
forwarded_ Sequence[str]hosts Specifies a list of Hosts for which matching should be applied.
- x
Azure List<String>Fdids Specifies a list of Azure Front Door IDs.
- x
Fd StringHealth Probe Specifies if a Front Door Health Probe should be expected. The only possible value is
1
.- x
Forwarded List<String>Fors Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- x
Forwarded List<String>Hosts Specifies a list of Hosts for which matching should be applied.
WindowsWebAppSiteConfigScmIpRestriction
- Action string
The action to take. Possible values are
Allow
orDeny
.- Headers
Windows
Web App Site Config Scm Ip Restriction Headers A
headers
block as defined above.- Ip
Address string The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24
or192.168.10.1/32
- Name string
The name which should be used for this
ip_restriction
.- Priority int
The priority value of this
ip_restriction
. Defaults to65000
.- Service
Tag string The Service Tag used for this IP Restriction.
- Virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
- Action string
The action to take. Possible values are
Allow
orDeny
.- Headers
Windows
Web App Site Config Scm Ip Restriction Headers A
headers
block as defined above.- Ip
Address string The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24
or192.168.10.1/32
- Name string
The name which should be used for this
ip_restriction
.- Priority int
The priority value of this
ip_restriction
. Defaults to65000
.- Service
Tag string The Service Tag used for this IP Restriction.
- Virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
- action String
The action to take. Possible values are
Allow
orDeny
.- headers
Windows
Web App Site Config Scm Ip Restriction Headers A
headers
block as defined above.- ip
Address String The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24
or192.168.10.1/32
- name String
The name which should be used for this
ip_restriction
.- priority Integer
The priority value of this
ip_restriction
. Defaults to65000
.- service
Tag String The Service Tag used for this IP Restriction.
- virtual
Network StringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
- action string
The action to take. Possible values are
Allow
orDeny
.- headers
Windows
Web App Site Config Scm Ip Restriction Headers A
headers
block as defined above.- ip
Address string The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24
or192.168.10.1/32
- name string
The name which should be used for this
ip_restriction
.- priority number
The priority value of this
ip_restriction
. Defaults to65000
.- service
Tag string The Service Tag used for this IP Restriction.
- virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
- action str
The action to take. Possible values are
Allow
orDeny
.- headers
Windows
Web App Site Config Scm Ip Restriction Headers 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
or192.168.10.1/32
- name str
The name which should be used for this
ip_restriction
.- priority int
The priority value of this
ip_restriction
. Defaults to65000
.- service_
tag str The Service Tag used for this IP Restriction.
- virtual_
network_ strsubnet_ id The Virtual Network Subnet ID used for this IP Restriction.
- action String
The action to take. Possible values are
Allow
orDeny
.- headers Property Map
A
headers
block as defined above.- ip
Address String The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24
or192.168.10.1/32
- name String
The name which should be used for this
ip_restriction
.- priority Number
The priority value of this
ip_restriction
. Defaults to65000
.- service
Tag String The Service Tag used for this IP Restriction.
- virtual
Network StringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
WindowsWebAppSiteConfigScmIpRestrictionHeaders
- XAzure
Fdids List<string> Specifies a list of Azure Front Door IDs.
- XFd
Health stringProbe Specifies if a Front Door Health Probe should be expected. The only possible value is
1
.- XForwarded
Fors List<string> Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- XForwarded
Hosts List<string> Specifies a list of Hosts for which matching should be applied.
- XAzure
Fdids []string Specifies a list of Azure Front Door IDs.
- XFd
Health stringProbe Specifies if a Front Door Health Probe should be expected. The only possible value is
1
.- XForwarded
Fors []string Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- XForwarded
Hosts []string Specifies a list of Hosts for which matching should be applied.
- x
Azure List<String>Fdids Specifies a list of Azure Front Door IDs.
- x
Fd StringHealth Probe Specifies if a Front Door Health Probe should be expected. The only possible value is
1
.- x
Forwarded List<String>Fors Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- x
Forwarded List<String>Hosts Specifies a list of Hosts for which matching should be applied.
- x
Azure string[]Fdids Specifies a list of Azure Front Door IDs.
- x
Fd stringHealth Probe Specifies if a Front Door Health Probe should be expected. The only possible value is
1
.- x
Forwarded string[]Fors Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- x
Forwarded string[]Hosts Specifies a list of Hosts for which matching should be applied.
- x_
azure_ Sequence[str]fdids Specifies a list of Azure Front Door IDs.
- x_
fd_ strhealth_ probe Specifies if a Front Door Health Probe should be expected. The only possible value is
1
.- x_
forwarded_ Sequence[str]fors Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- x_
forwarded_ Sequence[str]hosts Specifies a list of Hosts for which matching should be applied.
- x
Azure List<String>Fdids Specifies a list of Azure Front Door IDs.
- x
Fd StringHealth Probe Specifies if a Front Door Health Probe should be expected. The only possible value is
1
.- x
Forwarded List<String>Fors Specifies a list of addresses for which matching should be applied. Omitting this value means allow any.
- x
Forwarded List<String>Hosts Specifies a list of Hosts for which matching should be applied.
WindowsWebAppSiteConfigVirtualApplication
- Physical
Path string The physical path for the Virtual Application.
- Preload bool
Should pre-loading be enabled.
- Virtual
Path string The Virtual Path for the Virtual Application.
- Virtual
Directories List<WindowsWeb App Site Config Virtual Application Virtual Directory> One or more
virtual_directory
blocks as defined below.
- Physical
Path string The physical path for the Virtual Application.
- Preload bool
Should pre-loading be enabled.
- Virtual
Path string The Virtual Path for the Virtual Application.
- Virtual
Directories []WindowsWeb App Site Config Virtual Application Virtual Directory One or more
virtual_directory
blocks as defined below.
- physical
Path String The physical path for the Virtual Application.
- preload Boolean
Should pre-loading be enabled.
- virtual
Path String The Virtual Path for the Virtual Application.
- virtual
Directories List<WindowsWeb App Site Config Virtual Application Virtual Directory> One or more
virtual_directory
blocks as defined below.
- physical
Path string The physical path for the Virtual Application.
- preload boolean
Should pre-loading be enabled.
- virtual
Path string The Virtual Path for the Virtual Application.
- virtual
Directories WindowsWeb App Site Config Virtual Application Virtual Directory[] 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[WindowsWeb App Site Config Virtual Application Virtual Directory] One or more
virtual_directory
blocks as defined below.
- physical
Path String The physical path for the Virtual Application.
- preload Boolean
Should pre-loading be enabled.
- virtual
Path String The Virtual Path for the Virtual Application.
- virtual
Directories List<Property Map> One or more
virtual_directory
blocks as defined below.
WindowsWebAppSiteConfigVirtualApplicationVirtualDirectory
- Physical
Path string The physical path for the Virtual Application.
- Virtual
Path string The Virtual Path for the Virtual Application.
- Physical
Path string The physical path for the Virtual Application.
- Virtual
Path string The Virtual Path for the Virtual Application.
- physical
Path String The physical path for the Virtual Application.
- virtual
Path String The Virtual Path for the Virtual Application.
- physical
Path string The physical path for the Virtual Application.
- virtual
Path 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.
- physical
Path String The physical path for the Virtual Application.
- virtual
Path String The Virtual Path for the Virtual Application.
WindowsWebAppSiteCredential
WindowsWebAppStickySettings
- App
Setting List<string>Names A list of
app_setting
names that the Windows Web App will not swap between Slots when a swap operation is triggered.- Connection
String List<string>Names A list of
connection_string
names that the Windows Web App will not swap between Slots when a swap operation is triggered.
- App
Setting []stringNames A list of
app_setting
names that the Windows Web App will not swap between Slots when a swap operation is triggered.- Connection
String []stringNames A list of
connection_string
names that the Windows Web App will not swap between Slots when a swap operation is triggered.
- app
Setting List<String>Names A list of
app_setting
names that the Windows Web App will not swap between Slots when a swap operation is triggered.- connection
String List<String>Names A list of
connection_string
names that the Windows Web App will not swap between Slots when a swap operation is triggered.
- app
Setting string[]Names A list of
app_setting
names that the Windows Web App will not swap between Slots when a swap operation is triggered.- connection
String string[]Names A list of
connection_string
names that the Windows Web App will not swap between Slots when a swap operation is triggered.
- app_
setting_ Sequence[str]names A list of
app_setting
names that the Windows Web App will not swap between Slots when a swap operation is triggered.- connection_
string_ Sequence[str]names A list of
connection_string
names that the Windows Web App will not swap between Slots when a swap operation is triggered.
- app
Setting List<String>Names A list of
app_setting
names that the Windows Web App will not swap between Slots when a swap operation is triggered.- connection
String List<String>Names A list of
connection_string
names that the Windows Web App will not swap between Slots when a swap operation is triggered.
WindowsWebAppStorageAccount
- Access
Key string The Access key for the storage account.
- Account
Name string The Name of the Storage Account.
- Name string
The name which should be used for this TODO.
- string
The Name of the File Share or Container Name for Blob storage.
- Type string
The Azure Storage Type. Possible values include
AzureFiles
andAzureBlob
- Mount
Path string The path at which to mount the storage share.
- Access
Key string The Access key for the storage account.
- Account
Name string The Name of the Storage Account.
- Name string
The name which should be used for this TODO.
- string
The Name of the File Share or Container Name for Blob storage.
- Type string
The Azure Storage Type. Possible values include
AzureFiles
andAzureBlob
- Mount
Path string The path at which to mount the storage share.
- access
Key String The Access key for the storage account.
- account
Name String The Name of the Storage Account.
- name String
The name which should be used for this TODO.
- String
The Name of the File Share or Container Name for Blob storage.
- type String
The Azure Storage Type. Possible values include
AzureFiles
andAzureBlob
- mount
Path String The path at which to mount the storage share.
- access
Key string The Access key for the storage account.
- account
Name string The Name of the Storage Account.
- name string
The name which should be used for this TODO.
- string
The Name of the File Share or Container Name for Blob storage.
- type string
The Azure Storage Type. Possible values include
AzureFiles
andAzureBlob
- mount
Path string The path at which to mount the storage share.
- access_
key str The Access key for the storage account.
- account_
name str The Name of the Storage Account.
- name str
The name which should be used for this TODO.
- str
The Name of the File Share or Container Name for Blob storage.
- type str
The Azure Storage Type. Possible values include
AzureFiles
andAzureBlob
- mount_
path str The path at which to mount the storage share.
- access
Key String The Access key for the storage account.
- account
Name String The Name of the Storage Account.
- name String
The name which should be used for this TODO.
- String
The Name of the File Share or Container Name for Blob storage.
- type String
The Azure Storage Type. Possible values include
AzureFiles
andAzureBlob
- mount
Path 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.