Docs Home
We recommend using Azure Native.
Azure v6.22.1 published on Monday, May 12, 2025 by Pulumi
azure.appservice.WindowsWebApp
Explore with Pulumi AI
Manages a Windows Web App.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleServicePlan = new azure.appservice.ServicePlan("example", {
name: "example",
resourceGroupName: example.name,
location: example.location,
skuName: "P1v2",
osType: "Windows",
});
const exampleWindowsWebApp = new azure.appservice.WindowsWebApp("example", {
name: "example",
resourceGroupName: example.name,
location: exampleServicePlan.location,
servicePlanId: exampleServicePlan.id,
siteConfig: {},
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_service_plan = azure.appservice.ServicePlan("example",
name="example",
resource_group_name=example.name,
location=example.location,
sku_name="P1v2",
os_type="Windows")
example_windows_web_app = azure.appservice.WindowsWebApp("example",
name="example",
resource_group_name=example.name,
location=example_service_plan.location,
service_plan_id=example_service_plan.id,
site_config={})
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/appservice"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleServicePlan, err := appservice.NewServicePlan(ctx, "example", &appservice.ServicePlanArgs{
Name: pulumi.String("example"),
ResourceGroupName: example.Name,
Location: example.Location,
SkuName: pulumi.String("P1v2"),
OsType: pulumi.String("Windows"),
})
if err != nil {
return err
}
_, err = appservice.NewWindowsWebApp(ctx, "example", &appservice.WindowsWebAppArgs{
Name: pulumi.String("example"),
ResourceGroupName: example.Name,
Location: exampleServicePlan.Location,
ServicePlanId: exampleServicePlan.ID(),
SiteConfig: &appservice.WindowsWebAppSiteConfigArgs{},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleServicePlan = new Azure.AppService.ServicePlan("example", new()
{
Name = "example",
ResourceGroupName = example.Name,
Location = example.Location,
SkuName = "P1v2",
OsType = "Windows",
});
var exampleWindowsWebApp = new Azure.AppService.WindowsWebApp("example", new()
{
Name = "example",
ResourceGroupName = example.Name,
Location = exampleServicePlan.Location,
ServicePlanId = exampleServicePlan.Id,
SiteConfig = null,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleServicePlan = new ServicePlan("exampleServicePlan", ServicePlanArgs.builder()
.name("example")
.resourceGroupName(example.name())
.location(example.location())
.skuName("P1v2")
.osType("Windows")
.build());
var exampleWindowsWebApp = new WindowsWebApp("exampleWindowsWebApp", WindowsWebAppArgs.builder()
.name("example")
.resourceGroupName(example.name())
.location(exampleServicePlan.location())
.servicePlanId(exampleServicePlan.id())
.siteConfig(WindowsWebAppSiteConfigArgs.builder()
.build())
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleServicePlan:
type: azure:appservice:ServicePlan
name: example
properties:
name: example
resourceGroupName: ${example.name}
location: ${example.location}
skuName: P1v2
osType: Windows
exampleWindowsWebApp:
type: azure:appservice:WindowsWebApp
name: example
properties:
name: example
resourceGroupName: ${example.name}
location: ${exampleServicePlan.location}
servicePlanId: ${exampleServicePlan.id}
siteConfig: {}
Create WindowsWebApp Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new WindowsWebApp(name: string, args: WindowsWebAppArgs, opts?: CustomResourceOptions);@overload
def WindowsWebApp(resource_name: str,
args: WindowsWebAppArgs,
opts: Optional[ResourceOptions] = None)
@overload
def WindowsWebApp(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
site_config: Optional[WindowsWebAppSiteConfigArgs] = None,
service_plan_id: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = 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,
ftp_publish_basic_authentication_enabled: Optional[bool] = None,
https_only: Optional[bool] = None,
identity: Optional[WindowsWebAppIdentityArgs] = None,
key_vault_reference_identity_id: Optional[str] = None,
app_settings: Optional[Mapping[str, str]] = None,
logs: Optional[WindowsWebAppLogsArgs] = None,
client_affinity_enabled: Optional[bool] = None,
public_network_access_enabled: Optional[bool] = None,
backup: Optional[WindowsWebAppBackupArgs] = None,
auth_settings_v2: Optional[WindowsWebAppAuthSettingsV2Args] = None,
auth_settings: Optional[WindowsWebAppAuthSettingsArgs] = None,
sticky_settings: Optional[WindowsWebAppStickySettingsArgs] = None,
storage_accounts: Optional[Sequence[WindowsWebAppStorageAccountArgs]] = None,
tags: Optional[Mapping[str, str]] = None,
virtual_network_backup_restore_enabled: Optional[bool] = None,
virtual_network_subnet_id: Optional[str] = None,
webdeploy_publish_basic_authentication_enabled: Optional[bool] = None,
zip_deploy_file: Optional[str] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var windowsWebAppResource = new Azure.AppService.WindowsWebApp("windowsWebAppResource", new()
{
ResourceGroupName = "string",
SiteConfig = new Azure.AppService.Inputs.WindowsWebAppSiteConfigArgs
{
AlwaysOn = false,
ApiDefinitionUrl = "string",
ApiManagementApiId = "string",
AppCommandLine = "string",
ApplicationStack = new Azure.AppService.Inputs.WindowsWebAppSiteConfigApplicationStackArgs
{
CurrentStack = "string",
DockerImageName = "string",
DockerRegistryPassword = "string",
DockerRegistryUrl = "string",
DockerRegistryUsername = "string",
DotnetCoreVersion = "string",
DotnetVersion = "string",
JavaEmbeddedServerEnabled = false,
JavaVersion = "string",
NodeVersion = "string",
PhpVersion = "string",
Python = false,
TomcatVersion = "string",
},
AutoHealSetting = new Azure.AppService.Inputs.WindowsWebAppSiteConfigAutoHealSettingArgs
{
Action = new Azure.AppService.Inputs.WindowsWebAppSiteConfigAutoHealSettingActionArgs
{
ActionType = "string",
CustomAction = new Azure.AppService.Inputs.WindowsWebAppSiteConfigAutoHealSettingActionCustomActionArgs
{
Executable = "string",
Parameters = "string",
},
MinimumProcessExecutionTime = "string",
},
Trigger = new Azure.AppService.Inputs.WindowsWebAppSiteConfigAutoHealSettingTriggerArgs
{
PrivateMemoryKb = 0,
Requests = new Azure.AppService.Inputs.WindowsWebAppSiteConfigAutoHealSettingTriggerRequestsArgs
{
Count = 0,
Interval = "string",
},
SlowRequest = new Azure.AppService.Inputs.WindowsWebAppSiteConfigAutoHealSettingTriggerSlowRequestArgs
{
Count = 0,
Interval = "string",
TimeTaken = "string",
},
SlowRequestWithPaths = new[]
{
new Azure.AppService.Inputs.WindowsWebAppSiteConfigAutoHealSettingTriggerSlowRequestWithPathArgs
{
Count = 0,
Interval = "string",
TimeTaken = "string",
Path = "string",
},
},
StatusCodes = new[]
{
new Azure.AppService.Inputs.WindowsWebAppSiteConfigAutoHealSettingTriggerStatusCodeArgs
{
Count = 0,
Interval = "string",
StatusCodeRange = "string",
Path = "string",
SubStatus = 0,
Win32StatusCode = 0,
},
},
},
},
ContainerRegistryManagedIdentityClientId = "string",
ContainerRegistryUseManagedIdentity = false,
Cors = new Azure.AppService.Inputs.WindowsWebAppSiteConfigCorsArgs
{
AllowedOrigins = new[]
{
"string",
},
SupportCredentials = false,
},
DefaultDocuments = new[]
{
"string",
},
DetailedErrorLoggingEnabled = false,
FtpsState = "string",
HandlerMappings = new[]
{
new Azure.AppService.Inputs.WindowsWebAppSiteConfigHandlerMappingArgs
{
Extension = "string",
ScriptProcessorPath = "string",
Arguments = "string",
},
},
HealthCheckEvictionTimeInMin = 0,
HealthCheckPath = "string",
Http2Enabled = false,
IpRestrictionDefaultAction = "string",
IpRestrictions = new[]
{
new Azure.AppService.Inputs.WindowsWebAppSiteConfigIpRestrictionArgs
{
Action = "string",
Description = "string",
Headers = new Azure.AppService.Inputs.WindowsWebAppSiteConfigIpRestrictionHeadersArgs
{
XAzureFdids = new[]
{
"string",
},
XFdHealthProbe = "string",
XForwardedFors = new[]
{
"string",
},
XForwardedHosts = new[]
{
"string",
},
},
IpAddress = "string",
Name = "string",
Priority = 0,
ServiceTag = "string",
VirtualNetworkSubnetId = "string",
},
},
LinuxFxVersion = "string",
LoadBalancingMode = "string",
LocalMysqlEnabled = false,
ManagedPipelineMode = "string",
MinimumTlsVersion = "string",
RemoteDebuggingEnabled = false,
RemoteDebuggingVersion = "string",
ScmIpRestrictionDefaultAction = "string",
ScmIpRestrictions = new[]
{
new Azure.AppService.Inputs.WindowsWebAppSiteConfigScmIpRestrictionArgs
{
Action = "string",
Description = "string",
Headers = new Azure.AppService.Inputs.WindowsWebAppSiteConfigScmIpRestrictionHeadersArgs
{
XAzureFdids = new[]
{
"string",
},
XFdHealthProbe = "string",
XForwardedFors = new[]
{
"string",
},
XForwardedHosts = new[]
{
"string",
},
},
IpAddress = "string",
Name = "string",
Priority = 0,
ServiceTag = "string",
VirtualNetworkSubnetId = "string",
},
},
ScmMinimumTlsVersion = "string",
ScmType = "string",
ScmUseMainIpRestriction = false,
Use32BitWorker = false,
VirtualApplications = new[]
{
new Azure.AppService.Inputs.WindowsWebAppSiteConfigVirtualApplicationArgs
{
PhysicalPath = "string",
Preload = false,
VirtualPath = "string",
VirtualDirectories = new[]
{
new Azure.AppService.Inputs.WindowsWebAppSiteConfigVirtualApplicationVirtualDirectoryArgs
{
PhysicalPath = "string",
VirtualPath = "string",
},
},
},
},
VnetRouteAllEnabled = false,
WebsocketsEnabled = false,
WindowsFxVersion = "string",
WorkerCount = 0,
},
ServicePlanId = "string",
Location = "string",
Name = "string",
ClientCertificateEnabled = false,
ClientCertificateExclusionPaths = "string",
ClientCertificateMode = "string",
ConnectionStrings = new[]
{
new Azure.AppService.Inputs.WindowsWebAppConnectionStringArgs
{
Name = "string",
Type = "string",
Value = "string",
},
},
Enabled = false,
FtpPublishBasicAuthenticationEnabled = false,
HttpsOnly = false,
Identity = new Azure.AppService.Inputs.WindowsWebAppIdentityArgs
{
Type = "string",
IdentityIds = new[]
{
"string",
},
PrincipalId = "string",
TenantId = "string",
},
KeyVaultReferenceIdentityId = "string",
AppSettings =
{
{ "string", "string" },
},
Logs = new Azure.AppService.Inputs.WindowsWebAppLogsArgs
{
ApplicationLogs = new Azure.AppService.Inputs.WindowsWebAppLogsApplicationLogsArgs
{
FileSystemLevel = "string",
AzureBlobStorage = new Azure.AppService.Inputs.WindowsWebAppLogsApplicationLogsAzureBlobStorageArgs
{
Level = "string",
RetentionInDays = 0,
SasUrl = "string",
},
},
DetailedErrorMessages = false,
FailedRequestTracing = false,
HttpLogs = new Azure.AppService.Inputs.WindowsWebAppLogsHttpLogsArgs
{
AzureBlobStorage = new Azure.AppService.Inputs.WindowsWebAppLogsHttpLogsAzureBlobStorageArgs
{
SasUrl = "string",
RetentionInDays = 0,
},
FileSystem = new Azure.AppService.Inputs.WindowsWebAppLogsHttpLogsFileSystemArgs
{
RetentionInDays = 0,
RetentionInMb = 0,
},
},
},
ClientAffinityEnabled = false,
PublicNetworkAccessEnabled = false,
Backup = new Azure.AppService.Inputs.WindowsWebAppBackupArgs
{
Name = "string",
Schedule = new Azure.AppService.Inputs.WindowsWebAppBackupScheduleArgs
{
FrequencyInterval = 0,
FrequencyUnit = "string",
KeepAtLeastOneBackup = false,
LastExecutionTime = "string",
RetentionPeriodDays = 0,
StartTime = "string",
},
StorageAccountUrl = "string",
Enabled = false,
},
AuthSettingsV2 = new Azure.AppService.Inputs.WindowsWebAppAuthSettingsV2Args
{
Login = new Azure.AppService.Inputs.WindowsWebAppAuthSettingsV2LoginArgs
{
AllowedExternalRedirectUrls = new[]
{
"string",
},
CookieExpirationConvention = "string",
CookieExpirationTime = "string",
LogoutEndpoint = "string",
NonceExpirationTime = "string",
PreserveUrlFragmentsForLogins = false,
TokenRefreshExtensionTime = 0,
TokenStoreEnabled = false,
TokenStorePath = "string",
TokenStoreSasSettingName = "string",
ValidateNonce = false,
},
CustomOidcV2s = new[]
{
new Azure.AppService.Inputs.WindowsWebAppAuthSettingsV2CustomOidcV2Args
{
ClientId = "string",
Name = "string",
OpenidConfigurationEndpoint = "string",
AuthorisationEndpoint = "string",
CertificationUri = "string",
ClientCredentialMethod = "string",
ClientSecretSettingName = "string",
IssuerEndpoint = "string",
NameClaimType = "string",
Scopes = new[]
{
"string",
},
TokenEndpoint = "string",
},
},
GithubV2 = new Azure.AppService.Inputs.WindowsWebAppAuthSettingsV2GithubV2Args
{
ClientId = "string",
ClientSecretSettingName = "string",
LoginScopes = new[]
{
"string",
},
},
AzureStaticWebAppV2 = new Azure.AppService.Inputs.WindowsWebAppAuthSettingsV2AzureStaticWebAppV2Args
{
ClientId = "string",
},
ConfigFilePath = "string",
ActiveDirectoryV2 = new Azure.AppService.Inputs.WindowsWebAppAuthSettingsV2ActiveDirectoryV2Args
{
ClientId = "string",
TenantAuthEndpoint = "string",
AllowedApplications = new[]
{
"string",
},
AllowedAudiences = new[]
{
"string",
},
AllowedGroups = new[]
{
"string",
},
AllowedIdentities = new[]
{
"string",
},
ClientSecretCertificateThumbprint = "string",
ClientSecretSettingName = "string",
JwtAllowedClientApplications = new[]
{
"string",
},
JwtAllowedGroups = new[]
{
"string",
},
LoginParameters =
{
{ "string", "string" },
},
WwwAuthenticationDisabled = false,
},
DefaultProvider = "string",
ExcludedPaths = new[]
{
"string",
},
FacebookV2 = new Azure.AppService.Inputs.WindowsWebAppAuthSettingsV2FacebookV2Args
{
AppId = "string",
AppSecretSettingName = "string",
GraphApiVersion = "string",
LoginScopes = new[]
{
"string",
},
},
ForwardProxyConvention = "string",
ForwardProxyCustomHostHeaderName = "string",
AuthEnabled = false,
GoogleV2 = new Azure.AppService.Inputs.WindowsWebAppAuthSettingsV2GoogleV2Args
{
ClientId = "string",
ClientSecretSettingName = "string",
AllowedAudiences = new[]
{
"string",
},
LoginScopes = new[]
{
"string",
},
},
ForwardProxyCustomSchemeHeaderName = "string",
HttpRouteApiPrefix = "string",
AppleV2 = new Azure.AppService.Inputs.WindowsWebAppAuthSettingsV2AppleV2Args
{
ClientId = "string",
ClientSecretSettingName = "string",
LoginScopes = new[]
{
"string",
},
},
MicrosoftV2 = new Azure.AppService.Inputs.WindowsWebAppAuthSettingsV2MicrosoftV2Args
{
ClientId = "string",
ClientSecretSettingName = "string",
AllowedAudiences = new[]
{
"string",
},
LoginScopes = new[]
{
"string",
},
},
RequireAuthentication = false,
RequireHttps = false,
RuntimeVersion = "string",
TwitterV2 = new Azure.AppService.Inputs.WindowsWebAppAuthSettingsV2TwitterV2Args
{
ConsumerKey = "string",
ConsumerSecretSettingName = "string",
},
UnauthenticatedAction = "string",
},
AuthSettings = new Azure.AppService.Inputs.WindowsWebAppAuthSettingsArgs
{
Enabled = false,
Github = new Azure.AppService.Inputs.WindowsWebAppAuthSettingsGithubArgs
{
ClientId = "string",
ClientSecret = "string",
ClientSecretSettingName = "string",
OauthScopes = new[]
{
"string",
},
},
Issuer = "string",
DefaultProvider = "string",
AdditionalLoginParameters =
{
{ "string", "string" },
},
Facebook = new Azure.AppService.Inputs.WindowsWebAppAuthSettingsFacebookArgs
{
AppId = "string",
AppSecret = "string",
AppSecretSettingName = "string",
OauthScopes = new[]
{
"string",
},
},
ActiveDirectory = new Azure.AppService.Inputs.WindowsWebAppAuthSettingsActiveDirectoryArgs
{
ClientId = "string",
AllowedAudiences = new[]
{
"string",
},
ClientSecret = "string",
ClientSecretSettingName = "string",
},
Google = new Azure.AppService.Inputs.WindowsWebAppAuthSettingsGoogleArgs
{
ClientId = "string",
ClientSecret = "string",
ClientSecretSettingName = "string",
OauthScopes = new[]
{
"string",
},
},
AllowedExternalRedirectUrls = new[]
{
"string",
},
Microsoft = new Azure.AppService.Inputs.WindowsWebAppAuthSettingsMicrosoftArgs
{
ClientId = "string",
ClientSecret = "string",
ClientSecretSettingName = "string",
OauthScopes = new[]
{
"string",
},
},
RuntimeVersion = "string",
TokenRefreshExtensionHours = 0,
TokenStoreEnabled = false,
Twitter = new Azure.AppService.Inputs.WindowsWebAppAuthSettingsTwitterArgs
{
ConsumerKey = "string",
ConsumerSecret = "string",
ConsumerSecretSettingName = "string",
},
UnauthenticatedClientAction = "string",
},
StickySettings = new Azure.AppService.Inputs.WindowsWebAppStickySettingsArgs
{
AppSettingNames = new[]
{
"string",
},
ConnectionStringNames = new[]
{
"string",
},
},
StorageAccounts = new[]
{
new Azure.AppService.Inputs.WindowsWebAppStorageAccountArgs
{
AccessKey = "string",
AccountName = "string",
Name = "string",
ShareName = "string",
Type = "string",
MountPath = "string",
},
},
Tags =
{
{ "string", "string" },
},
VirtualNetworkBackupRestoreEnabled = false,
VirtualNetworkSubnetId = "string",
WebdeployPublishBasicAuthenticationEnabled = false,
ZipDeployFile = "string",
});
example, err := appservice.NewWindowsWebApp(ctx, "windowsWebAppResource", &appservice.WindowsWebAppArgs{
ResourceGroupName: pulumi.String("string"),
SiteConfig: &appservice.WindowsWebAppSiteConfigArgs{
AlwaysOn: pulumi.Bool(false),
ApiDefinitionUrl: pulumi.String("string"),
ApiManagementApiId: pulumi.String("string"),
AppCommandLine: pulumi.String("string"),
ApplicationStack: &appservice.WindowsWebAppSiteConfigApplicationStackArgs{
CurrentStack: pulumi.String("string"),
DockerImageName: pulumi.String("string"),
DockerRegistryPassword: pulumi.String("string"),
DockerRegistryUrl: pulumi.String("string"),
DockerRegistryUsername: pulumi.String("string"),
DotnetCoreVersion: pulumi.String("string"),
DotnetVersion: pulumi.String("string"),
JavaEmbeddedServerEnabled: pulumi.Bool(false),
JavaVersion: pulumi.String("string"),
NodeVersion: pulumi.String("string"),
PhpVersion: pulumi.String("string"),
Python: pulumi.Bool(false),
TomcatVersion: pulumi.String("string"),
},
AutoHealSetting: &appservice.WindowsWebAppSiteConfigAutoHealSettingArgs{
Action: &appservice.WindowsWebAppSiteConfigAutoHealSettingActionArgs{
ActionType: pulumi.String("string"),
CustomAction: &appservice.WindowsWebAppSiteConfigAutoHealSettingActionCustomActionArgs{
Executable: pulumi.String("string"),
Parameters: pulumi.String("string"),
},
MinimumProcessExecutionTime: pulumi.String("string"),
},
Trigger: &appservice.WindowsWebAppSiteConfigAutoHealSettingTriggerArgs{
PrivateMemoryKb: pulumi.Int(0),
Requests: &appservice.WindowsWebAppSiteConfigAutoHealSettingTriggerRequestsArgs{
Count: pulumi.Int(0),
Interval: pulumi.String("string"),
},
SlowRequest: &appservice.WindowsWebAppSiteConfigAutoHealSettingTriggerSlowRequestArgs{
Count: pulumi.Int(0),
Interval: pulumi.String("string"),
TimeTaken: pulumi.String("string"),
},
SlowRequestWithPaths: appservice.WindowsWebAppSiteConfigAutoHealSettingTriggerSlowRequestWithPathArray{
&appservice.WindowsWebAppSiteConfigAutoHealSettingTriggerSlowRequestWithPathArgs{
Count: pulumi.Int(0),
Interval: pulumi.String("string"),
TimeTaken: pulumi.String("string"),
Path: pulumi.String("string"),
},
},
StatusCodes: appservice.WindowsWebAppSiteConfigAutoHealSettingTriggerStatusCodeArray{
&appservice.WindowsWebAppSiteConfigAutoHealSettingTriggerStatusCodeArgs{
Count: pulumi.Int(0),
Interval: pulumi.String("string"),
StatusCodeRange: pulumi.String("string"),
Path: pulumi.String("string"),
SubStatus: pulumi.Int(0),
Win32StatusCode: pulumi.Int(0),
},
},
},
},
ContainerRegistryManagedIdentityClientId: pulumi.String("string"),
ContainerRegistryUseManagedIdentity: pulumi.Bool(false),
Cors: &appservice.WindowsWebAppSiteConfigCorsArgs{
AllowedOrigins: pulumi.StringArray{
pulumi.String("string"),
},
SupportCredentials: pulumi.Bool(false),
},
DefaultDocuments: pulumi.StringArray{
pulumi.String("string"),
},
DetailedErrorLoggingEnabled: pulumi.Bool(false),
FtpsState: pulumi.String("string"),
HandlerMappings: appservice.WindowsWebAppSiteConfigHandlerMappingArray{
&appservice.WindowsWebAppSiteConfigHandlerMappingArgs{
Extension: pulumi.String("string"),
ScriptProcessorPath: pulumi.String("string"),
Arguments: pulumi.String("string"),
},
},
HealthCheckEvictionTimeInMin: pulumi.Int(0),
HealthCheckPath: pulumi.String("string"),
Http2Enabled: pulumi.Bool(false),
IpRestrictionDefaultAction: pulumi.String("string"),
IpRestrictions: appservice.WindowsWebAppSiteConfigIpRestrictionArray{
&appservice.WindowsWebAppSiteConfigIpRestrictionArgs{
Action: pulumi.String("string"),
Description: pulumi.String("string"),
Headers: &appservice.WindowsWebAppSiteConfigIpRestrictionHeadersArgs{
XAzureFdids: pulumi.StringArray{
pulumi.String("string"),
},
XFdHealthProbe: pulumi.String("string"),
XForwardedFors: pulumi.StringArray{
pulumi.String("string"),
},
XForwardedHosts: pulumi.StringArray{
pulumi.String("string"),
},
},
IpAddress: pulumi.String("string"),
Name: pulumi.String("string"),
Priority: pulumi.Int(0),
ServiceTag: pulumi.String("string"),
VirtualNetworkSubnetId: pulumi.String("string"),
},
},
LinuxFxVersion: pulumi.String("string"),
LoadBalancingMode: pulumi.String("string"),
LocalMysqlEnabled: pulumi.Bool(false),
ManagedPipelineMode: pulumi.String("string"),
MinimumTlsVersion: pulumi.String("string"),
RemoteDebuggingEnabled: pulumi.Bool(false),
RemoteDebuggingVersion: pulumi.String("string"),
ScmIpRestrictionDefaultAction: pulumi.String("string"),
ScmIpRestrictions: appservice.WindowsWebAppSiteConfigScmIpRestrictionArray{
&appservice.WindowsWebAppSiteConfigScmIpRestrictionArgs{
Action: pulumi.String("string"),
Description: pulumi.String("string"),
Headers: &appservice.WindowsWebAppSiteConfigScmIpRestrictionHeadersArgs{
XAzureFdids: pulumi.StringArray{
pulumi.String("string"),
},
XFdHealthProbe: pulumi.String("string"),
XForwardedFors: pulumi.StringArray{
pulumi.String("string"),
},
XForwardedHosts: pulumi.StringArray{
pulumi.String("string"),
},
},
IpAddress: pulumi.String("string"),
Name: pulumi.String("string"),
Priority: pulumi.Int(0),
ServiceTag: pulumi.String("string"),
VirtualNetworkSubnetId: pulumi.String("string"),
},
},
ScmMinimumTlsVersion: pulumi.String("string"),
ScmType: pulumi.String("string"),
ScmUseMainIpRestriction: pulumi.Bool(false),
Use32BitWorker: pulumi.Bool(false),
VirtualApplications: appservice.WindowsWebAppSiteConfigVirtualApplicationArray{
&appservice.WindowsWebAppSiteConfigVirtualApplicationArgs{
PhysicalPath: pulumi.String("string"),
Preload: pulumi.Bool(false),
VirtualPath: pulumi.String("string"),
VirtualDirectories: appservice.WindowsWebAppSiteConfigVirtualApplicationVirtualDirectoryArray{
&appservice.WindowsWebAppSiteConfigVirtualApplicationVirtualDirectoryArgs{
PhysicalPath: pulumi.String("string"),
VirtualPath: pulumi.String("string"),
},
},
},
},
VnetRouteAllEnabled: pulumi.Bool(false),
WebsocketsEnabled: pulumi.Bool(false),
WindowsFxVersion: pulumi.String("string"),
WorkerCount: pulumi.Int(0),
},
ServicePlanId: pulumi.String("string"),
Location: pulumi.String("string"),
Name: pulumi.String("string"),
ClientCertificateEnabled: pulumi.Bool(false),
ClientCertificateExclusionPaths: pulumi.String("string"),
ClientCertificateMode: pulumi.String("string"),
ConnectionStrings: appservice.WindowsWebAppConnectionStringArray{
&appservice.WindowsWebAppConnectionStringArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Enabled: pulumi.Bool(false),
FtpPublishBasicAuthenticationEnabled: pulumi.Bool(false),
HttpsOnly: pulumi.Bool(false),
Identity: &appservice.WindowsWebAppIdentityArgs{
Type: pulumi.String("string"),
IdentityIds: pulumi.StringArray{
pulumi.String("string"),
},
PrincipalId: pulumi.String("string"),
TenantId: pulumi.String("string"),
},
KeyVaultReferenceIdentityId: pulumi.String("string"),
AppSettings: pulumi.StringMap{
"string": pulumi.String("string"),
},
Logs: &appservice.WindowsWebAppLogsArgs{
ApplicationLogs: &appservice.WindowsWebAppLogsApplicationLogsArgs{
FileSystemLevel: pulumi.String("string"),
AzureBlobStorage: &appservice.WindowsWebAppLogsApplicationLogsAzureBlobStorageArgs{
Level: pulumi.String("string"),
RetentionInDays: pulumi.Int(0),
SasUrl: pulumi.String("string"),
},
},
DetailedErrorMessages: pulumi.Bool(false),
FailedRequestTracing: pulumi.Bool(false),
HttpLogs: &appservice.WindowsWebAppLogsHttpLogsArgs{
AzureBlobStorage: &appservice.WindowsWebAppLogsHttpLogsAzureBlobStorageArgs{
SasUrl: pulumi.String("string"),
RetentionInDays: pulumi.Int(0),
},
FileSystem: &appservice.WindowsWebAppLogsHttpLogsFileSystemArgs{
RetentionInDays: pulumi.Int(0),
RetentionInMb: pulumi.Int(0),
},
},
},
ClientAffinityEnabled: pulumi.Bool(false),
PublicNetworkAccessEnabled: pulumi.Bool(false),
Backup: &appservice.WindowsWebAppBackupArgs{
Name: pulumi.String("string"),
Schedule: &appservice.WindowsWebAppBackupScheduleArgs{
FrequencyInterval: pulumi.Int(0),
FrequencyUnit: pulumi.String("string"),
KeepAtLeastOneBackup: pulumi.Bool(false),
LastExecutionTime: pulumi.String("string"),
RetentionPeriodDays: pulumi.Int(0),
StartTime: pulumi.String("string"),
},
StorageAccountUrl: pulumi.String("string"),
Enabled: pulumi.Bool(false),
},
AuthSettingsV2: &appservice.WindowsWebAppAuthSettingsV2Args{
Login: &appservice.WindowsWebAppAuthSettingsV2LoginArgs{
AllowedExternalRedirectUrls: pulumi.StringArray{
pulumi.String("string"),
},
CookieExpirationConvention: pulumi.String("string"),
CookieExpirationTime: pulumi.String("string"),
LogoutEndpoint: pulumi.String("string"),
NonceExpirationTime: pulumi.String("string"),
PreserveUrlFragmentsForLogins: pulumi.Bool(false),
TokenRefreshExtensionTime: pulumi.Float64(0),
TokenStoreEnabled: pulumi.Bool(false),
TokenStorePath: pulumi.String("string"),
TokenStoreSasSettingName: pulumi.String("string"),
ValidateNonce: pulumi.Bool(false),
},
CustomOidcV2s: appservice.WindowsWebAppAuthSettingsV2CustomOidcV2Array{
&appservice.WindowsWebAppAuthSettingsV2CustomOidcV2Args{
ClientId: pulumi.String("string"),
Name: pulumi.String("string"),
OpenidConfigurationEndpoint: pulumi.String("string"),
AuthorisationEndpoint: pulumi.String("string"),
CertificationUri: pulumi.String("string"),
ClientCredentialMethod: pulumi.String("string"),
ClientSecretSettingName: pulumi.String("string"),
IssuerEndpoint: pulumi.String("string"),
NameClaimType: pulumi.String("string"),
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
TokenEndpoint: pulumi.String("string"),
},
},
GithubV2: &appservice.WindowsWebAppAuthSettingsV2GithubV2Args{
ClientId: pulumi.String("string"),
ClientSecretSettingName: pulumi.String("string"),
LoginScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
AzureStaticWebAppV2: &appservice.WindowsWebAppAuthSettingsV2AzureStaticWebAppV2Args{
ClientId: pulumi.String("string"),
},
ConfigFilePath: pulumi.String("string"),
ActiveDirectoryV2: &appservice.WindowsWebAppAuthSettingsV2ActiveDirectoryV2Args{
ClientId: pulumi.String("string"),
TenantAuthEndpoint: pulumi.String("string"),
AllowedApplications: pulumi.StringArray{
pulumi.String("string"),
},
AllowedAudiences: pulumi.StringArray{
pulumi.String("string"),
},
AllowedGroups: pulumi.StringArray{
pulumi.String("string"),
},
AllowedIdentities: pulumi.StringArray{
pulumi.String("string"),
},
ClientSecretCertificateThumbprint: pulumi.String("string"),
ClientSecretSettingName: pulumi.String("string"),
JwtAllowedClientApplications: pulumi.StringArray{
pulumi.String("string"),
},
JwtAllowedGroups: pulumi.StringArray{
pulumi.String("string"),
},
LoginParameters: pulumi.StringMap{
"string": pulumi.String("string"),
},
WwwAuthenticationDisabled: pulumi.Bool(false),
},
DefaultProvider: pulumi.String("string"),
ExcludedPaths: pulumi.StringArray{
pulumi.String("string"),
},
FacebookV2: &appservice.WindowsWebAppAuthSettingsV2FacebookV2Args{
AppId: pulumi.String("string"),
AppSecretSettingName: pulumi.String("string"),
GraphApiVersion: pulumi.String("string"),
LoginScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
ForwardProxyConvention: pulumi.String("string"),
ForwardProxyCustomHostHeaderName: pulumi.String("string"),
AuthEnabled: pulumi.Bool(false),
GoogleV2: &appservice.WindowsWebAppAuthSettingsV2GoogleV2Args{
ClientId: pulumi.String("string"),
ClientSecretSettingName: pulumi.String("string"),
AllowedAudiences: pulumi.StringArray{
pulumi.String("string"),
},
LoginScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
ForwardProxyCustomSchemeHeaderName: pulumi.String("string"),
HttpRouteApiPrefix: pulumi.String("string"),
AppleV2: &appservice.WindowsWebAppAuthSettingsV2AppleV2Args{
ClientId: pulumi.String("string"),
ClientSecretSettingName: pulumi.String("string"),
LoginScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
MicrosoftV2: &appservice.WindowsWebAppAuthSettingsV2MicrosoftV2Args{
ClientId: pulumi.String("string"),
ClientSecretSettingName: pulumi.String("string"),
AllowedAudiences: pulumi.StringArray{
pulumi.String("string"),
},
LoginScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
RequireAuthentication: pulumi.Bool(false),
RequireHttps: pulumi.Bool(false),
RuntimeVersion: pulumi.String("string"),
TwitterV2: &appservice.WindowsWebAppAuthSettingsV2TwitterV2Args{
ConsumerKey: pulumi.String("string"),
ConsumerSecretSettingName: pulumi.String("string"),
},
UnauthenticatedAction: pulumi.String("string"),
},
AuthSettings: &appservice.WindowsWebAppAuthSettingsArgs{
Enabled: pulumi.Bool(false),
Github: &appservice.WindowsWebAppAuthSettingsGithubArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
ClientSecretSettingName: pulumi.String("string"),
OauthScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
Issuer: pulumi.String("string"),
DefaultProvider: pulumi.String("string"),
AdditionalLoginParameters: pulumi.StringMap{
"string": pulumi.String("string"),
},
Facebook: &appservice.WindowsWebAppAuthSettingsFacebookArgs{
AppId: pulumi.String("string"),
AppSecret: pulumi.String("string"),
AppSecretSettingName: pulumi.String("string"),
OauthScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
ActiveDirectory: &appservice.WindowsWebAppAuthSettingsActiveDirectoryArgs{
ClientId: pulumi.String("string"),
AllowedAudiences: pulumi.StringArray{
pulumi.String("string"),
},
ClientSecret: pulumi.String("string"),
ClientSecretSettingName: pulumi.String("string"),
},
Google: &appservice.WindowsWebAppAuthSettingsGoogleArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
ClientSecretSettingName: pulumi.String("string"),
OauthScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
AllowedExternalRedirectUrls: pulumi.StringArray{
pulumi.String("string"),
},
Microsoft: &appservice.WindowsWebAppAuthSettingsMicrosoftArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
ClientSecretSettingName: pulumi.String("string"),
OauthScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
RuntimeVersion: pulumi.String("string"),
TokenRefreshExtensionHours: pulumi.Float64(0),
TokenStoreEnabled: pulumi.Bool(false),
Twitter: &appservice.WindowsWebAppAuthSettingsTwitterArgs{
ConsumerKey: pulumi.String("string"),
ConsumerSecret: pulumi.String("string"),
ConsumerSecretSettingName: pulumi.String("string"),
},
UnauthenticatedClientAction: pulumi.String("string"),
},
StickySettings: &appservice.WindowsWebAppStickySettingsArgs{
AppSettingNames: pulumi.StringArray{
pulumi.String("string"),
},
ConnectionStringNames: pulumi.StringArray{
pulumi.String("string"),
},
},
StorageAccounts: appservice.WindowsWebAppStorageAccountArray{
&appservice.WindowsWebAppStorageAccountArgs{
AccessKey: pulumi.String("string"),
AccountName: pulumi.String("string"),
Name: pulumi.String("string"),
ShareName: pulumi.String("string"),
Type: pulumi.String("string"),
MountPath: pulumi.String("string"),
},
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
VirtualNetworkBackupRestoreEnabled: pulumi.Bool(false),
VirtualNetworkSubnetId: pulumi.String("string"),
WebdeployPublishBasicAuthenticationEnabled: pulumi.Bool(false),
ZipDeployFile: pulumi.String("string"),
})
var windowsWebAppResource = new WindowsWebApp("windowsWebAppResource", WindowsWebAppArgs.builder()
.resourceGroupName("string")
.siteConfig(WindowsWebAppSiteConfigArgs.builder()
.alwaysOn(false)
.apiDefinitionUrl("string")
.apiManagementApiId("string")
.appCommandLine("string")
.applicationStack(WindowsWebAppSiteConfigApplicationStackArgs.builder()
.currentStack("string")
.dockerImageName("string")
.dockerRegistryPassword("string")
.dockerRegistryUrl("string")
.dockerRegistryUsername("string")
.dotnetCoreVersion("string")
.dotnetVersion("string")
.javaEmbeddedServerEnabled(false)
.javaVersion("string")
.nodeVersion("string")
.phpVersion("string")
.python(false)
.tomcatVersion("string")
.build())
.autoHealSetting(WindowsWebAppSiteConfigAutoHealSettingArgs.builder()
.action(WindowsWebAppSiteConfigAutoHealSettingActionArgs.builder()
.actionType("string")
.customAction(WindowsWebAppSiteConfigAutoHealSettingActionCustomActionArgs.builder()
.executable("string")
.parameters("string")
.build())
.minimumProcessExecutionTime("string")
.build())
.trigger(WindowsWebAppSiteConfigAutoHealSettingTriggerArgs.builder()
.privateMemoryKb(0)
.requests(WindowsWebAppSiteConfigAutoHealSettingTriggerRequestsArgs.builder()
.count(0)
.interval("string")
.build())
.slowRequest(WindowsWebAppSiteConfigAutoHealSettingTriggerSlowRequestArgs.builder()
.count(0)
.interval("string")
.timeTaken("string")
.build())
.slowRequestWithPaths(WindowsWebAppSiteConfigAutoHealSettingTriggerSlowRequestWithPathArgs.builder()
.count(0)
.interval("string")
.timeTaken("string")
.path("string")
.build())
.statusCodes(WindowsWebAppSiteConfigAutoHealSettingTriggerStatusCodeArgs.builder()
.count(0)
.interval("string")
.statusCodeRange("string")
.path("string")
.subStatus(0)
.win32StatusCode(0)
.build())
.build())
.build())
.containerRegistryManagedIdentityClientId("string")
.containerRegistryUseManagedIdentity(false)
.cors(WindowsWebAppSiteConfigCorsArgs.builder()
.allowedOrigins("string")
.supportCredentials(false)
.build())
.defaultDocuments("string")
.detailedErrorLoggingEnabled(false)
.ftpsState("string")
.handlerMappings(WindowsWebAppSiteConfigHandlerMappingArgs.builder()
.extension("string")
.scriptProcessorPath("string")
.arguments("string")
.build())
.healthCheckEvictionTimeInMin(0)
.healthCheckPath("string")
.http2Enabled(false)
.ipRestrictionDefaultAction("string")
.ipRestrictions(WindowsWebAppSiteConfigIpRestrictionArgs.builder()
.action("string")
.description("string")
.headers(WindowsWebAppSiteConfigIpRestrictionHeadersArgs.builder()
.xAzureFdids("string")
.xFdHealthProbe("string")
.xForwardedFors("string")
.xForwardedHosts("string")
.build())
.ipAddress("string")
.name("string")
.priority(0)
.serviceTag("string")
.virtualNetworkSubnetId("string")
.build())
.linuxFxVersion("string")
.loadBalancingMode("string")
.localMysqlEnabled(false)
.managedPipelineMode("string")
.minimumTlsVersion("string")
.remoteDebuggingEnabled(false)
.remoteDebuggingVersion("string")
.scmIpRestrictionDefaultAction("string")
.scmIpRestrictions(WindowsWebAppSiteConfigScmIpRestrictionArgs.builder()
.action("string")
.description("string")
.headers(WindowsWebAppSiteConfigScmIpRestrictionHeadersArgs.builder()
.xAzureFdids("string")
.xFdHealthProbe("string")
.xForwardedFors("string")
.xForwardedHosts("string")
.build())
.ipAddress("string")
.name("string")
.priority(0)
.serviceTag("string")
.virtualNetworkSubnetId("string")
.build())
.scmMinimumTlsVersion("string")
.scmType("string")
.scmUseMainIpRestriction(false)
.use32BitWorker(false)
.virtualApplications(WindowsWebAppSiteConfigVirtualApplicationArgs.builder()
.physicalPath("string")
.preload(false)
.virtualPath("string")
.virtualDirectories(WindowsWebAppSiteConfigVirtualApplicationVirtualDirectoryArgs.builder()
.physicalPath("string")
.virtualPath("string")
.build())
.build())
.vnetRouteAllEnabled(false)
.websocketsEnabled(false)
.windowsFxVersion("string")
.workerCount(0)
.build())
.servicePlanId("string")
.location("string")
.name("string")
.clientCertificateEnabled(false)
.clientCertificateExclusionPaths("string")
.clientCertificateMode("string")
.connectionStrings(WindowsWebAppConnectionStringArgs.builder()
.name("string")
.type("string")
.value("string")
.build())
.enabled(false)
.ftpPublishBasicAuthenticationEnabled(false)
.httpsOnly(false)
.identity(WindowsWebAppIdentityArgs.builder()
.type("string")
.identityIds("string")
.principalId("string")
.tenantId("string")
.build())
.keyVaultReferenceIdentityId("string")
.appSettings(Map.of("string", "string"))
.logs(WindowsWebAppLogsArgs.builder()
.applicationLogs(WindowsWebAppLogsApplicationLogsArgs.builder()
.fileSystemLevel("string")
.azureBlobStorage(WindowsWebAppLogsApplicationLogsAzureBlobStorageArgs.builder()
.level("string")
.retentionInDays(0)
.sasUrl("string")
.build())
.build())
.detailedErrorMessages(false)
.failedRequestTracing(false)
.httpLogs(WindowsWebAppLogsHttpLogsArgs.builder()
.azureBlobStorage(WindowsWebAppLogsHttpLogsAzureBlobStorageArgs.builder()
.sasUrl("string")
.retentionInDays(0)
.build())
.fileSystem(WindowsWebAppLogsHttpLogsFileSystemArgs.builder()
.retentionInDays(0)
.retentionInMb(0)
.build())
.build())
.build())
.clientAffinityEnabled(false)
.publicNetworkAccessEnabled(false)
.backup(WindowsWebAppBackupArgs.builder()
.name("string")
.schedule(WindowsWebAppBackupScheduleArgs.builder()
.frequencyInterval(0)
.frequencyUnit("string")
.keepAtLeastOneBackup(false)
.lastExecutionTime("string")
.retentionPeriodDays(0)
.startTime("string")
.build())
.storageAccountUrl("string")
.enabled(false)
.build())
.authSettingsV2(WindowsWebAppAuthSettingsV2Args.builder()
.login(WindowsWebAppAuthSettingsV2LoginArgs.builder()
.allowedExternalRedirectUrls("string")
.cookieExpirationConvention("string")
.cookieExpirationTime("string")
.logoutEndpoint("string")
.nonceExpirationTime("string")
.preserveUrlFragmentsForLogins(false)
.tokenRefreshExtensionTime(0.0)
.tokenStoreEnabled(false)
.tokenStorePath("string")
.tokenStoreSasSettingName("string")
.validateNonce(false)
.build())
.customOidcV2s(WindowsWebAppAuthSettingsV2CustomOidcV2Args.builder()
.clientId("string")
.name("string")
.openidConfigurationEndpoint("string")
.authorisationEndpoint("string")
.certificationUri("string")
.clientCredentialMethod("string")
.clientSecretSettingName("string")
.issuerEndpoint("string")
.nameClaimType("string")
.scopes("string")
.tokenEndpoint("string")
.build())
.githubV2(WindowsWebAppAuthSettingsV2GithubV2Args.builder()
.clientId("string")
.clientSecretSettingName("string")
.loginScopes("string")
.build())
.azureStaticWebAppV2(WindowsWebAppAuthSettingsV2AzureStaticWebAppV2Args.builder()
.clientId("string")
.build())
.configFilePath("string")
.activeDirectoryV2(WindowsWebAppAuthSettingsV2ActiveDirectoryV2Args.builder()
.clientId("string")
.tenantAuthEndpoint("string")
.allowedApplications("string")
.allowedAudiences("string")
.allowedGroups("string")
.allowedIdentities("string")
.clientSecretCertificateThumbprint("string")
.clientSecretSettingName("string")
.jwtAllowedClientApplications("string")
.jwtAllowedGroups("string")
.loginParameters(Map.of("string", "string"))
.wwwAuthenticationDisabled(false)
.build())
.defaultProvider("string")
.excludedPaths("string")
.facebookV2(WindowsWebAppAuthSettingsV2FacebookV2Args.builder()
.appId("string")
.appSecretSettingName("string")
.graphApiVersion("string")
.loginScopes("string")
.build())
.forwardProxyConvention("string")
.forwardProxyCustomHostHeaderName("string")
.authEnabled(false)
.googleV2(WindowsWebAppAuthSettingsV2GoogleV2Args.builder()
.clientId("string")
.clientSecretSettingName("string")
.allowedAudiences("string")
.loginScopes("string")
.build())
.forwardProxyCustomSchemeHeaderName("string")
.httpRouteApiPrefix("string")
.appleV2(WindowsWebAppAuthSettingsV2AppleV2Args.builder()
.clientId("string")
.clientSecretSettingName("string")
.loginScopes("string")
.build())
.microsoftV2(WindowsWebAppAuthSettingsV2MicrosoftV2Args.builder()
.clientId("string")
.clientSecretSettingName("string")
.allowedAudiences("string")
.loginScopes("string")
.build())
.requireAuthentication(false)
.requireHttps(false)
.runtimeVersion("string")
.twitterV2(WindowsWebAppAuthSettingsV2TwitterV2Args.builder()
.consumerKey("string")
.consumerSecretSettingName("string")
.build())
.unauthenticatedAction("string")
.build())
.authSettings(WindowsWebAppAuthSettingsArgs.builder()
.enabled(false)
.github(WindowsWebAppAuthSettingsGithubArgs.builder()
.clientId("string")
.clientSecret("string")
.clientSecretSettingName("string")
.oauthScopes("string")
.build())
.issuer("string")
.defaultProvider("string")
.additionalLoginParameters(Map.of("string", "string"))
.facebook(WindowsWebAppAuthSettingsFacebookArgs.builder()
.appId("string")
.appSecret("string")
.appSecretSettingName("string")
.oauthScopes("string")
.build())
.activeDirectory(WindowsWebAppAuthSettingsActiveDirectoryArgs.builder()
.clientId("string")
.allowedAudiences("string")
.clientSecret("string")
.clientSecretSettingName("string")
.build())
.google(WindowsWebAppAuthSettingsGoogleArgs.builder()
.clientId("string")
.clientSecret("string")
.clientSecretSettingName("string")
.oauthScopes("string")
.build())
.allowedExternalRedirectUrls("string")
.microsoft(WindowsWebAppAuthSettingsMicrosoftArgs.builder()
.clientId("string")
.clientSecret("string")
.clientSecretSettingName("string")
.oauthScopes("string")
.build())
.runtimeVersion("string")
.tokenRefreshExtensionHours(0.0)
.tokenStoreEnabled(false)
.twitter(WindowsWebAppAuthSettingsTwitterArgs.builder()
.consumerKey("string")
.consumerSecret("string")
.consumerSecretSettingName("string")
.build())
.unauthenticatedClientAction("string")
.build())
.stickySettings(WindowsWebAppStickySettingsArgs.builder()
.appSettingNames("string")
.connectionStringNames("string")
.build())
.storageAccounts(WindowsWebAppStorageAccountArgs.builder()
.accessKey("string")
.accountName("string")
.name("string")
.shareName("string")
.type("string")
.mountPath("string")
.build())
.tags(Map.of("string", "string"))
.virtualNetworkBackupRestoreEnabled(false)
.virtualNetworkSubnetId("string")
.webdeployPublishBasicAuthenticationEnabled(false)
.zipDeployFile("string")
.build());
windows_web_app_resource = azure.appservice.WindowsWebApp("windowsWebAppResource",
resource_group_name="string",
site_config={
"always_on": False,
"api_definition_url": "string",
"api_management_api_id": "string",
"app_command_line": "string",
"application_stack": {
"current_stack": "string",
"docker_image_name": "string",
"docker_registry_password": "string",
"docker_registry_url": "string",
"docker_registry_username": "string",
"dotnet_core_version": "string",
"dotnet_version": "string",
"java_embedded_server_enabled": False,
"java_version": "string",
"node_version": "string",
"php_version": "string",
"python": False,
"tomcat_version": "string",
},
"auto_heal_setting": {
"action": {
"action_type": "string",
"custom_action": {
"executable": "string",
"parameters": "string",
},
"minimum_process_execution_time": "string",
},
"trigger": {
"private_memory_kb": 0,
"requests": {
"count": 0,
"interval": "string",
},
"slow_request": {
"count": 0,
"interval": "string",
"time_taken": "string",
},
"slow_request_with_paths": [{
"count": 0,
"interval": "string",
"time_taken": "string",
"path": "string",
}],
"status_codes": [{
"count": 0,
"interval": "string",
"status_code_range": "string",
"path": "string",
"sub_status": 0,
"win32_status_code": 0,
}],
},
},
"container_registry_managed_identity_client_id": "string",
"container_registry_use_managed_identity": False,
"cors": {
"allowed_origins": ["string"],
"support_credentials": False,
},
"default_documents": ["string"],
"detailed_error_logging_enabled": False,
"ftps_state": "string",
"handler_mappings": [{
"extension": "string",
"script_processor_path": "string",
"arguments": "string",
}],
"health_check_eviction_time_in_min": 0,
"health_check_path": "string",
"http2_enabled": False,
"ip_restriction_default_action": "string",
"ip_restrictions": [{
"action": "string",
"description": "string",
"headers": {
"x_azure_fdids": ["string"],
"x_fd_health_probe": "string",
"x_forwarded_fors": ["string"],
"x_forwarded_hosts": ["string"],
},
"ip_address": "string",
"name": "string",
"priority": 0,
"service_tag": "string",
"virtual_network_subnet_id": "string",
}],
"linux_fx_version": "string",
"load_balancing_mode": "string",
"local_mysql_enabled": False,
"managed_pipeline_mode": "string",
"minimum_tls_version": "string",
"remote_debugging_enabled": False,
"remote_debugging_version": "string",
"scm_ip_restriction_default_action": "string",
"scm_ip_restrictions": [{
"action": "string",
"description": "string",
"headers": {
"x_azure_fdids": ["string"],
"x_fd_health_probe": "string",
"x_forwarded_fors": ["string"],
"x_forwarded_hosts": ["string"],
},
"ip_address": "string",
"name": "string",
"priority": 0,
"service_tag": "string",
"virtual_network_subnet_id": "string",
}],
"scm_minimum_tls_version": "string",
"scm_type": "string",
"scm_use_main_ip_restriction": False,
"use32_bit_worker": False,
"virtual_applications": [{
"physical_path": "string",
"preload": False,
"virtual_path": "string",
"virtual_directories": [{
"physical_path": "string",
"virtual_path": "string",
}],
}],
"vnet_route_all_enabled": False,
"websockets_enabled": False,
"windows_fx_version": "string",
"worker_count": 0,
},
service_plan_id="string",
location="string",
name="string",
client_certificate_enabled=False,
client_certificate_exclusion_paths="string",
client_certificate_mode="string",
connection_strings=[{
"name": "string",
"type": "string",
"value": "string",
}],
enabled=False,
ftp_publish_basic_authentication_enabled=False,
https_only=False,
identity={
"type": "string",
"identity_ids": ["string"],
"principal_id": "string",
"tenant_id": "string",
},
key_vault_reference_identity_id="string",
app_settings={
"string": "string",
},
logs={
"application_logs": {
"file_system_level": "string",
"azure_blob_storage": {
"level": "string",
"retention_in_days": 0,
"sas_url": "string",
},
},
"detailed_error_messages": False,
"failed_request_tracing": False,
"http_logs": {
"azure_blob_storage": {
"sas_url": "string",
"retention_in_days": 0,
},
"file_system": {
"retention_in_days": 0,
"retention_in_mb": 0,
},
},
},
client_affinity_enabled=False,
public_network_access_enabled=False,
backup={
"name": "string",
"schedule": {
"frequency_interval": 0,
"frequency_unit": "string",
"keep_at_least_one_backup": False,
"last_execution_time": "string",
"retention_period_days": 0,
"start_time": "string",
},
"storage_account_url": "string",
"enabled": False,
},
auth_settings_v2={
"login": {
"allowed_external_redirect_urls": ["string"],
"cookie_expiration_convention": "string",
"cookie_expiration_time": "string",
"logout_endpoint": "string",
"nonce_expiration_time": "string",
"preserve_url_fragments_for_logins": False,
"token_refresh_extension_time": 0,
"token_store_enabled": False,
"token_store_path": "string",
"token_store_sas_setting_name": "string",
"validate_nonce": False,
},
"custom_oidc_v2s": [{
"client_id": "string",
"name": "string",
"openid_configuration_endpoint": "string",
"authorisation_endpoint": "string",
"certification_uri": "string",
"client_credential_method": "string",
"client_secret_setting_name": "string",
"issuer_endpoint": "string",
"name_claim_type": "string",
"scopes": ["string"],
"token_endpoint": "string",
}],
"github_v2": {
"client_id": "string",
"client_secret_setting_name": "string",
"login_scopes": ["string"],
},
"azure_static_web_app_v2": {
"client_id": "string",
},
"config_file_path": "string",
"active_directory_v2": {
"client_id": "string",
"tenant_auth_endpoint": "string",
"allowed_applications": ["string"],
"allowed_audiences": ["string"],
"allowed_groups": ["string"],
"allowed_identities": ["string"],
"client_secret_certificate_thumbprint": "string",
"client_secret_setting_name": "string",
"jwt_allowed_client_applications": ["string"],
"jwt_allowed_groups": ["string"],
"login_parameters": {
"string": "string",
},
"www_authentication_disabled": False,
},
"default_provider": "string",
"excluded_paths": ["string"],
"facebook_v2": {
"app_id": "string",
"app_secret_setting_name": "string",
"graph_api_version": "string",
"login_scopes": ["string"],
},
"forward_proxy_convention": "string",
"forward_proxy_custom_host_header_name": "string",
"auth_enabled": False,
"google_v2": {
"client_id": "string",
"client_secret_setting_name": "string",
"allowed_audiences": ["string"],
"login_scopes": ["string"],
},
"forward_proxy_custom_scheme_header_name": "string",
"http_route_api_prefix": "string",
"apple_v2": {
"client_id": "string",
"client_secret_setting_name": "string",
"login_scopes": ["string"],
},
"microsoft_v2": {
"client_id": "string",
"client_secret_setting_name": "string",
"allowed_audiences": ["string"],
"login_scopes": ["string"],
},
"require_authentication": False,
"require_https": False,
"runtime_version": "string",
"twitter_v2": {
"consumer_key": "string",
"consumer_secret_setting_name": "string",
},
"unauthenticated_action": "string",
},
auth_settings={
"enabled": False,
"github": {
"client_id": "string",
"client_secret": "string",
"client_secret_setting_name": "string",
"oauth_scopes": ["string"],
},
"issuer": "string",
"default_provider": "string",
"additional_login_parameters": {
"string": "string",
},
"facebook": {
"app_id": "string",
"app_secret": "string",
"app_secret_setting_name": "string",
"oauth_scopes": ["string"],
},
"active_directory": {
"client_id": "string",
"allowed_audiences": ["string"],
"client_secret": "string",
"client_secret_setting_name": "string",
},
"google": {
"client_id": "string",
"client_secret": "string",
"client_secret_setting_name": "string",
"oauth_scopes": ["string"],
},
"allowed_external_redirect_urls": ["string"],
"microsoft": {
"client_id": "string",
"client_secret": "string",
"client_secret_setting_name": "string",
"oauth_scopes": ["string"],
},
"runtime_version": "string",
"token_refresh_extension_hours": 0,
"token_store_enabled": False,
"twitter": {
"consumer_key": "string",
"consumer_secret": "string",
"consumer_secret_setting_name": "string",
},
"unauthenticated_client_action": "string",
},
sticky_settings={
"app_setting_names": ["string"],
"connection_string_names": ["string"],
},
storage_accounts=[{
"access_key": "string",
"account_name": "string",
"name": "string",
"share_name": "string",
"type": "string",
"mount_path": "string",
}],
tags={
"string": "string",
},
virtual_network_backup_restore_enabled=False,
virtual_network_subnet_id="string",
webdeploy_publish_basic_authentication_enabled=False,
zip_deploy_file="string")
const windowsWebAppResource = new azure.appservice.WindowsWebApp("windowsWebAppResource", {
resourceGroupName: "string",
siteConfig: {
alwaysOn: false,
apiDefinitionUrl: "string",
apiManagementApiId: "string",
appCommandLine: "string",
applicationStack: {
currentStack: "string",
dockerImageName: "string",
dockerRegistryPassword: "string",
dockerRegistryUrl: "string",
dockerRegistryUsername: "string",
dotnetCoreVersion: "string",
dotnetVersion: "string",
javaEmbeddedServerEnabled: false,
javaVersion: "string",
nodeVersion: "string",
phpVersion: "string",
python: false,
tomcatVersion: "string",
},
autoHealSetting: {
action: {
actionType: "string",
customAction: {
executable: "string",
parameters: "string",
},
minimumProcessExecutionTime: "string",
},
trigger: {
privateMemoryKb: 0,
requests: {
count: 0,
interval: "string",
},
slowRequest: {
count: 0,
interval: "string",
timeTaken: "string",
},
slowRequestWithPaths: [{
count: 0,
interval: "string",
timeTaken: "string",
path: "string",
}],
statusCodes: [{
count: 0,
interval: "string",
statusCodeRange: "string",
path: "string",
subStatus: 0,
win32StatusCode: 0,
}],
},
},
containerRegistryManagedIdentityClientId: "string",
containerRegistryUseManagedIdentity: false,
cors: {
allowedOrigins: ["string"],
supportCredentials: false,
},
defaultDocuments: ["string"],
detailedErrorLoggingEnabled: false,
ftpsState: "string",
handlerMappings: [{
extension: "string",
scriptProcessorPath: "string",
arguments: "string",
}],
healthCheckEvictionTimeInMin: 0,
healthCheckPath: "string",
http2Enabled: false,
ipRestrictionDefaultAction: "string",
ipRestrictions: [{
action: "string",
description: "string",
headers: {
xAzureFdids: ["string"],
xFdHealthProbe: "string",
xForwardedFors: ["string"],
xForwardedHosts: ["string"],
},
ipAddress: "string",
name: "string",
priority: 0,
serviceTag: "string",
virtualNetworkSubnetId: "string",
}],
linuxFxVersion: "string",
loadBalancingMode: "string",
localMysqlEnabled: false,
managedPipelineMode: "string",
minimumTlsVersion: "string",
remoteDebuggingEnabled: false,
remoteDebuggingVersion: "string",
scmIpRestrictionDefaultAction: "string",
scmIpRestrictions: [{
action: "string",
description: "string",
headers: {
xAzureFdids: ["string"],
xFdHealthProbe: "string",
xForwardedFors: ["string"],
xForwardedHosts: ["string"],
},
ipAddress: "string",
name: "string",
priority: 0,
serviceTag: "string",
virtualNetworkSubnetId: "string",
}],
scmMinimumTlsVersion: "string",
scmType: "string",
scmUseMainIpRestriction: false,
use32BitWorker: false,
virtualApplications: [{
physicalPath: "string",
preload: false,
virtualPath: "string",
virtualDirectories: [{
physicalPath: "string",
virtualPath: "string",
}],
}],
vnetRouteAllEnabled: false,
websocketsEnabled: false,
windowsFxVersion: "string",
workerCount: 0,
},
servicePlanId: "string",
location: "string",
name: "string",
clientCertificateEnabled: false,
clientCertificateExclusionPaths: "string",
clientCertificateMode: "string",
connectionStrings: [{
name: "string",
type: "string",
value: "string",
}],
enabled: false,
ftpPublishBasicAuthenticationEnabled: false,
httpsOnly: false,
identity: {
type: "string",
identityIds: ["string"],
principalId: "string",
tenantId: "string",
},
keyVaultReferenceIdentityId: "string",
appSettings: {
string: "string",
},
logs: {
applicationLogs: {
fileSystemLevel: "string",
azureBlobStorage: {
level: "string",
retentionInDays: 0,
sasUrl: "string",
},
},
detailedErrorMessages: false,
failedRequestTracing: false,
httpLogs: {
azureBlobStorage: {
sasUrl: "string",
retentionInDays: 0,
},
fileSystem: {
retentionInDays: 0,
retentionInMb: 0,
},
},
},
clientAffinityEnabled: false,
publicNetworkAccessEnabled: false,
backup: {
name: "string",
schedule: {
frequencyInterval: 0,
frequencyUnit: "string",
keepAtLeastOneBackup: false,
lastExecutionTime: "string",
retentionPeriodDays: 0,
startTime: "string",
},
storageAccountUrl: "string",
enabled: false,
},
authSettingsV2: {
login: {
allowedExternalRedirectUrls: ["string"],
cookieExpirationConvention: "string",
cookieExpirationTime: "string",
logoutEndpoint: "string",
nonceExpirationTime: "string",
preserveUrlFragmentsForLogins: false,
tokenRefreshExtensionTime: 0,
tokenStoreEnabled: false,
tokenStorePath: "string",
tokenStoreSasSettingName: "string",
validateNonce: false,
},
customOidcV2s: [{
clientId: "string",
name: "string",
openidConfigurationEndpoint: "string",
authorisationEndpoint: "string",
certificationUri: "string",
clientCredentialMethod: "string",
clientSecretSettingName: "string",
issuerEndpoint: "string",
nameClaimType: "string",
scopes: ["string"],
tokenEndpoint: "string",
}],
githubV2: {
clientId: "string",
clientSecretSettingName: "string",
loginScopes: ["string"],
},
azureStaticWebAppV2: {
clientId: "string",
},
configFilePath: "string",
activeDirectoryV2: {
clientId: "string",
tenantAuthEndpoint: "string",
allowedApplications: ["string"],
allowedAudiences: ["string"],
allowedGroups: ["string"],
allowedIdentities: ["string"],
clientSecretCertificateThumbprint: "string",
clientSecretSettingName: "string",
jwtAllowedClientApplications: ["string"],
jwtAllowedGroups: ["string"],
loginParameters: {
string: "string",
},
wwwAuthenticationDisabled: false,
},
defaultProvider: "string",
excludedPaths: ["string"],
facebookV2: {
appId: "string",
appSecretSettingName: "string",
graphApiVersion: "string",
loginScopes: ["string"],
},
forwardProxyConvention: "string",
forwardProxyCustomHostHeaderName: "string",
authEnabled: false,
googleV2: {
clientId: "string",
clientSecretSettingName: "string",
allowedAudiences: ["string"],
loginScopes: ["string"],
},
forwardProxyCustomSchemeHeaderName: "string",
httpRouteApiPrefix: "string",
appleV2: {
clientId: "string",
clientSecretSettingName: "string",
loginScopes: ["string"],
},
microsoftV2: {
clientId: "string",
clientSecretSettingName: "string",
allowedAudiences: ["string"],
loginScopes: ["string"],
},
requireAuthentication: false,
requireHttps: false,
runtimeVersion: "string",
twitterV2: {
consumerKey: "string",
consumerSecretSettingName: "string",
},
unauthenticatedAction: "string",
},
authSettings: {
enabled: false,
github: {
clientId: "string",
clientSecret: "string",
clientSecretSettingName: "string",
oauthScopes: ["string"],
},
issuer: "string",
defaultProvider: "string",
additionalLoginParameters: {
string: "string",
},
facebook: {
appId: "string",
appSecret: "string",
appSecretSettingName: "string",
oauthScopes: ["string"],
},
activeDirectory: {
clientId: "string",
allowedAudiences: ["string"],
clientSecret: "string",
clientSecretSettingName: "string",
},
google: {
clientId: "string",
clientSecret: "string",
clientSecretSettingName: "string",
oauthScopes: ["string"],
},
allowedExternalRedirectUrls: ["string"],
microsoft: {
clientId: "string",
clientSecret: "string",
clientSecretSettingName: "string",
oauthScopes: ["string"],
},
runtimeVersion: "string",
tokenRefreshExtensionHours: 0,
tokenStoreEnabled: false,
twitter: {
consumerKey: "string",
consumerSecret: "string",
consumerSecretSettingName: "string",
},
unauthenticatedClientAction: "string",
},
stickySettings: {
appSettingNames: ["string"],
connectionStringNames: ["string"],
},
storageAccounts: [{
accessKey: "string",
accountName: "string",
name: "string",
shareName: "string",
type: "string",
mountPath: "string",
}],
tags: {
string: "string",
},
virtualNetworkBackupRestoreEnabled: false,
virtualNetworkSubnetId: "string",
webdeployPublishBasicAuthenticationEnabled: false,
zipDeployFile: "string",
});
type: azure:appservice:WindowsWebApp
properties:
appSettings:
string: string
authSettings:
activeDirectory:
allowedAudiences:
- string
clientId: string
clientSecret: string
clientSecretSettingName: string
additionalLoginParameters:
string: string
allowedExternalRedirectUrls:
- string
defaultProvider: string
enabled: false
facebook:
appId: string
appSecret: string
appSecretSettingName: string
oauthScopes:
- string
github:
clientId: string
clientSecret: string
clientSecretSettingName: string
oauthScopes:
- string
google:
clientId: string
clientSecret: string
clientSecretSettingName: string
oauthScopes:
- string
issuer: string
microsoft:
clientId: string
clientSecret: string
clientSecretSettingName: string
oauthScopes:
- string
runtimeVersion: string
tokenRefreshExtensionHours: 0
tokenStoreEnabled: false
twitter:
consumerKey: string
consumerSecret: string
consumerSecretSettingName: string
unauthenticatedClientAction: string
authSettingsV2:
activeDirectoryV2:
allowedApplications:
- string
allowedAudiences:
- string
allowedGroups:
- string
allowedIdentities:
- string
clientId: string
clientSecretCertificateThumbprint: string
clientSecretSettingName: string
jwtAllowedClientApplications:
- string
jwtAllowedGroups:
- string
loginParameters:
string: string
tenantAuthEndpoint: string
wwwAuthenticationDisabled: false
appleV2:
clientId: string
clientSecretSettingName: string
loginScopes:
- string
authEnabled: false
azureStaticWebAppV2:
clientId: string
configFilePath: string
customOidcV2s:
- authorisationEndpoint: string
certificationUri: string
clientCredentialMethod: string
clientId: string
clientSecretSettingName: string
issuerEndpoint: string
name: string
nameClaimType: string
openidConfigurationEndpoint: string
scopes:
- string
tokenEndpoint: string
defaultProvider: string
excludedPaths:
- string
facebookV2:
appId: string
appSecretSettingName: string
graphApiVersion: string
loginScopes:
- string
forwardProxyConvention: string
forwardProxyCustomHostHeaderName: string
forwardProxyCustomSchemeHeaderName: string
githubV2:
clientId: string
clientSecretSettingName: string
loginScopes:
- string
googleV2:
allowedAudiences:
- string
clientId: string
clientSecretSettingName: string
loginScopes:
- string
httpRouteApiPrefix: string
login:
allowedExternalRedirectUrls:
- string
cookieExpirationConvention: string
cookieExpirationTime: string
logoutEndpoint: string
nonceExpirationTime: string
preserveUrlFragmentsForLogins: false
tokenRefreshExtensionTime: 0
tokenStoreEnabled: false
tokenStorePath: string
tokenStoreSasSettingName: string
validateNonce: false
microsoftV2:
allowedAudiences:
- string
clientId: string
clientSecretSettingName: string
loginScopes:
- string
requireAuthentication: false
requireHttps: false
runtimeVersion: string
twitterV2:
consumerKey: string
consumerSecretSettingName: string
unauthenticatedAction: string
backup:
enabled: false
name: string
schedule:
frequencyInterval: 0
frequencyUnit: string
keepAtLeastOneBackup: false
lastExecutionTime: string
retentionPeriodDays: 0
startTime: string
storageAccountUrl: string
clientAffinityEnabled: false
clientCertificateEnabled: false
clientCertificateExclusionPaths: string
clientCertificateMode: string
connectionStrings:
- name: string
type: string
value: string
enabled: false
ftpPublishBasicAuthenticationEnabled: false
httpsOnly: false
identity:
identityIds:
- string
principalId: string
tenantId: string
type: string
keyVaultReferenceIdentityId: string
location: string
logs:
applicationLogs:
azureBlobStorage:
level: string
retentionInDays: 0
sasUrl: string
fileSystemLevel: string
detailedErrorMessages: false
failedRequestTracing: false
httpLogs:
azureBlobStorage:
retentionInDays: 0
sasUrl: string
fileSystem:
retentionInDays: 0
retentionInMb: 0
name: string
publicNetworkAccessEnabled: false
resourceGroupName: string
servicePlanId: string
siteConfig:
alwaysOn: false
apiDefinitionUrl: string
apiManagementApiId: string
appCommandLine: string
applicationStack:
currentStack: string
dockerImageName: string
dockerRegistryPassword: string
dockerRegistryUrl: string
dockerRegistryUsername: string
dotnetCoreVersion: string
dotnetVersion: string
javaEmbeddedServerEnabled: false
javaVersion: string
nodeVersion: string
phpVersion: string
python: false
tomcatVersion: string
autoHealSetting:
action:
actionType: string
customAction:
executable: string
parameters: string
minimumProcessExecutionTime: string
trigger:
privateMemoryKb: 0
requests:
count: 0
interval: string
slowRequest:
count: 0
interval: string
timeTaken: string
slowRequestWithPaths:
- count: 0
interval: string
path: string
timeTaken: string
statusCodes:
- count: 0
interval: string
path: string
statusCodeRange: string
subStatus: 0
win32StatusCode: 0
containerRegistryManagedIdentityClientId: string
containerRegistryUseManagedIdentity: false
cors:
allowedOrigins:
- string
supportCredentials: false
defaultDocuments:
- string
detailedErrorLoggingEnabled: false
ftpsState: string
handlerMappings:
- arguments: string
extension: string
scriptProcessorPath: string
healthCheckEvictionTimeInMin: 0
healthCheckPath: string
http2Enabled: false
ipRestrictionDefaultAction: string
ipRestrictions:
- action: string
description: string
headers:
xAzureFdids:
- string
xFdHealthProbe: string
xForwardedFors:
- string
xForwardedHosts:
- string
ipAddress: string
name: string
priority: 0
serviceTag: string
virtualNetworkSubnetId: string
linuxFxVersion: string
loadBalancingMode: string
localMysqlEnabled: false
managedPipelineMode: string
minimumTlsVersion: string
remoteDebuggingEnabled: false
remoteDebuggingVersion: string
scmIpRestrictionDefaultAction: string
scmIpRestrictions:
- action: string
description: string
headers:
xAzureFdids:
- string
xFdHealthProbe: string
xForwardedFors:
- string
xForwardedHosts:
- string
ipAddress: string
name: string
priority: 0
serviceTag: string
virtualNetworkSubnetId: string
scmMinimumTlsVersion: string
scmType: string
scmUseMainIpRestriction: false
use32BitWorker: false
virtualApplications:
- physicalPath: string
preload: false
virtualDirectories:
- physicalPath: string
virtualPath: string
virtualPath: string
vnetRouteAllEnabled: false
websocketsEnabled: false
windowsFxVersion: string
workerCount: 0
stickySettings:
appSettingNames:
- string
connectionStringNames:
- string
storageAccounts:
- accessKey: string
accountName: string
mountPath: string
name: string
shareName: string
type: string
tags:
string: string
virtualNetworkBackupRestoreEnabled: false
virtualNetworkSubnetId: string
webdeployPublishBasicAuthenticationEnabled: false
zipDeployFile: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
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 - A
site_configblock as defined below. - App
Settings Dictionary<string, string> - A map of key-value pairs of App Settings.
- Auth
Settings WindowsWeb App Auth Settings - An
auth_settingsblock as defined below. - Auth
Settings WindowsV2 Web App Auth Settings V2 - An
auth_settings_v2block as defined below. - Backup
Windows
Web App Backup - A
backupblock 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_enabledisfalse. Defaults toRequired. - Connection
Strings List<WindowsWeb App Connection String> - One or more
connection_stringblocks as defined below. - Enabled bool
- Should the Windows Web App be enabled? Defaults to
true. - Ftp
Publish boolBasic Authentication Enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - Https
Only bool - Should the Windows Web App require HTTPS connections. Defaults to
false. - Identity
Windows
Web App Identity - An
identityblock as defined below. - Key
Vault stringReference Identity Id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. For more information see - Access vaults with a user-assigned identity - Location string
- The Azure Region where the Windows Web App should exist. Changing this forces a new Windows Web App to be created.
- Logs
Windows
Web App Logs - A
logsblock 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.
- Public
Network boolAccess Enabled - Should public network access be enabled for the Web App. Defaults to
true. - Sticky
Settings WindowsWeb App Sticky Settings - A
sticky_settingsblock as defined below. - Storage
Accounts List<WindowsWeb App Storage Account> One or more
storage_accountblocks as defined below.Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.- Dictionary<string, string>
- A mapping of tags which should be assigned to the Windows Web App.
- Virtual
Network boolBackup Restore Enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - Virtual
Network stringSubnet Id - Webdeploy
Publish boolBasic Authentication Enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- Zip
Deploy stringFile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
Note: Using this value requires either
WEBSITE_RUN_FROM_PACKAGE=1orSCM_DO_BUILD_DURING_DEPLOYMENT=trueto be set on the App inapp_settings. Refer to the Azure docs on running the Web App directly from the Zip package, or automating the build for Zip deploy for further details.
- 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_configblock 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_settingsblock as defined below. - Auth
Settings WindowsV2 Web App Auth Settings V2Args - An
auth_settings_v2block as defined below. - Backup
Windows
Web App Backup Args - A
backupblock 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_enabledisfalse. Defaults toRequired. - Connection
Strings []WindowsWeb App Connection String Args - One or more
connection_stringblocks as defined below. - Enabled bool
- Should the Windows Web App be enabled? Defaults to
true. - Ftp
Publish boolBasic Authentication Enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - Https
Only bool - Should the Windows Web App require HTTPS connections. Defaults to
false. - Identity
Windows
Web App Identity Args - An
identityblock as defined below. - Key
Vault stringReference Identity Id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. For more information see - Access vaults with a user-assigned identity - Location string
- The Azure Region where the Windows Web App should exist. Changing this forces a new Windows Web App to be created.
- Logs
Windows
Web App Logs Args - A
logsblock 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.
- Public
Network boolAccess Enabled - Should public network access be enabled for the Web App. Defaults to
true. - Sticky
Settings WindowsWeb App Sticky Settings Args - A
sticky_settingsblock as defined below. - Storage
Accounts []WindowsWeb App Storage Account Args One or more
storage_accountblocks as defined below.Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.- map[string]string
- A mapping of tags which should be assigned to the Windows Web App.
- Virtual
Network boolBackup Restore Enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - Virtual
Network stringSubnet Id - Webdeploy
Publish boolBasic Authentication Enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- Zip
Deploy stringFile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
Note: Using this value requires either
WEBSITE_RUN_FROM_PACKAGE=1orSCM_DO_BUILD_DURING_DEPLOYMENT=trueto be set on the App inapp_settings. Refer to the Azure docs on running the Web App directly from the Zip package, or automating the build for Zip deploy for further details.
- 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 - A
site_configblock as defined below. - app
Settings Map<String,String> - A map of key-value pairs of App Settings.
- auth
Settings WindowsWeb App Auth Settings - An
auth_settingsblock as defined below. - auth
Settings WindowsV2 Web App Auth Settings V2 - An
auth_settings_v2block as defined below. - backup
Windows
Web App Backup - A
backupblock 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_enabledisfalse. Defaults toRequired. - connection
Strings List<WindowsWeb App Connection String> - One or more
connection_stringblocks as defined below. - enabled Boolean
- Should the Windows Web App be enabled? Defaults to
true. - ftp
Publish BooleanBasic Authentication Enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - https
Only Boolean - Should the Windows Web App require HTTPS connections. Defaults to
false. - identity
Windows
Web App Identity - An
identityblock as defined below. - key
Vault StringReference Identity Id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. For more information see - Access vaults with a user-assigned identity - location String
- The Azure Region where the Windows Web App should exist. Changing this forces a new Windows Web App to be created.
- logs
Windows
Web App Logs - A
logsblock 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.
- public
Network BooleanAccess Enabled - Should public network access be enabled for the Web App. Defaults to
true. - sticky
Settings WindowsWeb App Sticky Settings - A
sticky_settingsblock as defined below. - storage
Accounts List<WindowsWeb App Storage Account> One or more
storage_accountblocks as defined below.Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.- Map<String,String>
- A mapping of tags which should be assigned to the Windows Web App.
- virtual
Network BooleanBackup Restore Enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - virtual
Network StringSubnet Id - webdeploy
Publish BooleanBasic Authentication Enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- zip
Deploy StringFile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
Note: Using this value requires either
WEBSITE_RUN_FROM_PACKAGE=1orSCM_DO_BUILD_DURING_DEPLOYMENT=trueto be set on the App inapp_settings. Refer to the Azure docs on running the Web App directly from the Zip package, or automating the build for Zip deploy for further details.
- 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 - A
site_configblock as defined below. - app
Settings {[key: string]: string} - A map of key-value pairs of App Settings.
- auth
Settings WindowsWeb App Auth Settings - An
auth_settingsblock as defined below. - auth
Settings WindowsV2 Web App Auth Settings V2 - An
auth_settings_v2block as defined below. - backup
Windows
Web App Backup - A
backupblock 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_enabledisfalse. Defaults toRequired. - connection
Strings WindowsWeb App Connection String[] - One or more
connection_stringblocks as defined below. - enabled boolean
- Should the Windows Web App be enabled? Defaults to
true. - ftp
Publish booleanBasic Authentication Enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - https
Only boolean - Should the Windows Web App require HTTPS connections. Defaults to
false. - identity
Windows
Web App Identity - An
identityblock as defined below. - key
Vault stringReference Identity Id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. For more information see - Access vaults with a user-assigned identity - location string
- The Azure Region where the Windows Web App should exist. Changing this forces a new Windows Web App to be created.
- logs
Windows
Web App Logs - A
logsblock 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.
- public
Network booleanAccess Enabled - Should public network access be enabled for the Web App. Defaults to
true. - sticky
Settings WindowsWeb App Sticky Settings - A
sticky_settingsblock as defined below. - storage
Accounts WindowsWeb App Storage Account[] One or more
storage_accountblocks as defined below.Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.- {[key: string]: string}
- A mapping of tags which should be assigned to the Windows Web App.
- virtual
Network booleanBackup Restore Enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - virtual
Network stringSubnet Id - webdeploy
Publish booleanBasic Authentication Enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- zip
Deploy stringFile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
Note: Using this value requires either
WEBSITE_RUN_FROM_PACKAGE=1orSCM_DO_BUILD_DURING_DEPLOYMENT=trueto be set on the App inapp_settings. Refer to the Azure docs on running the Web App directly from the Zip package, or automating the build for Zip deploy for further details.
- 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_configblock 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_settingsblock as defined below. - auth_
settings_ Windowsv2 Web App Auth Settings V2Args - An
auth_settings_v2block as defined below. - backup
Windows
Web App Backup Args - A
backupblock 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_enabledisfalse. Defaults toRequired. - connection_
strings Sequence[WindowsWeb App Connection String Args] - One or more
connection_stringblocks as defined below. - enabled bool
- Should the Windows Web App be enabled? Defaults to
true. - ftp_
publish_ boolbasic_ authentication_ enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - https_
only bool - Should the Windows Web App require HTTPS connections. Defaults to
false. - identity
Windows
Web App Identity Args - An
identityblock as defined below. - key_
vault_ strreference_ identity_ id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. For more information see - Access vaults with a user-assigned identity - location str
- The Azure Region where the Windows Web App should exist. Changing this forces a new Windows Web App to be created.
- logs
Windows
Web App Logs Args - A
logsblock 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.
- public_
network_ boolaccess_ enabled - Should public network access be enabled for the Web App. Defaults to
true. - sticky_
settings WindowsWeb App Sticky Settings Args - A
sticky_settingsblock as defined below. - storage_
accounts Sequence[WindowsWeb App Storage Account Args] One or more
storage_accountblocks as defined below.Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.- Mapping[str, str]
- A mapping of tags which should be assigned to the Windows Web App.
- virtual_
network_ boolbackup_ restore_ enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - virtual_
network_ strsubnet_ id - webdeploy_
publish_ boolbasic_ authentication_ enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- zip_
deploy_ strfile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
Note: Using this value requires either
WEBSITE_RUN_FROM_PACKAGE=1orSCM_DO_BUILD_DURING_DEPLOYMENT=trueto be set on the App inapp_settings. Refer to the Azure docs on running the Web App directly from the Zip package, or automating the build for Zip deploy for further details.
- 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_configblock as defined below. - app
Settings Map<String> - A map of key-value pairs of App Settings.
- auth
Settings Property Map - An
auth_settingsblock as defined below. - auth
Settings Property MapV2 - An
auth_settings_v2block as defined below. - backup Property Map
- A
backupblock 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_enabledisfalse. Defaults toRequired. - connection
Strings List<Property Map> - One or more
connection_stringblocks as defined below. - enabled Boolean
- Should the Windows Web App be enabled? Defaults to
true. - ftp
Publish BooleanBasic Authentication Enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - https
Only Boolean - Should the Windows Web App require HTTPS connections. Defaults to
false. - identity Property Map
- An
identityblock as defined below. - key
Vault StringReference Identity Id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. For more information see - Access vaults with a user-assigned identity - location String
- The Azure Region where the Windows Web App should exist. Changing this forces a new Windows Web App to be created.
- logs Property Map
- A
logsblock 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.
- public
Network BooleanAccess Enabled - Should public network access be enabled for the Web App. Defaults to
true. - sticky
Settings Property Map - A
sticky_settingsblock as defined below. - storage
Accounts List<Property Map> One or more
storage_accountblocks as defined below.Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.- Map<String>
- A mapping of tags which should be assigned to the Windows Web App.
- virtual
Network BooleanBackup Restore Enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - virtual
Network StringSubnet Id - webdeploy
Publish BooleanBasic Authentication Enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- zip
Deploy StringFile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
Note: Using this value requires either
WEBSITE_RUN_FROM_PACKAGE=1orSCM_DO_BUILD_DURING_DEPLOYMENT=trueto be set on the App inapp_settings. Refer to the Azure docs on running the Web App directly from the Zip package, or automating the build for Zip deploy for further details.
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.
- Hosting
Environment stringId - The ID of the App Service Environment used by App Service.
- 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 list of possible outbound ip address.
- 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_credentialblock as defined below.
- Custom
Domain stringVerification Id - The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- Default
Hostname string - The default hostname of the Windows Web App.
- Hosting
Environment stringId - The ID of the App Service Environment used by App Service.
- 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 list of possible outbound ip address.
- 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_credentialblock as defined below.
- custom
Domain StringVerification Id - The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Hostname String - The default hostname of the Windows Web App.
- hosting
Environment StringId - The ID of the App Service Environment used by App Service.
- 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 list of possible outbound ip address.
- 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_credentialblock as defined below.
- custom
Domain stringVerification Id - The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Hostname string - The default hostname of the Windows Web App.
- hosting
Environment stringId - The ID of the App Service Environment used by App Service.
- 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 list of possible outbound ip address.
- 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_credentialblock as defined below.
- custom_
domain_ strverification_ id - The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default_
hostname str - The default hostname of the Windows Web App.
- hosting_
environment_ strid - The ID of the App Service Environment used by App Service.
- 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 list of possible outbound ip address.
- 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_credentialblock as defined below.
- custom
Domain StringVerification Id - The identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Hostname String - The default hostname of the Windows Web App.
- hosting
Environment StringId - The ID of the App Service Environment used by App Service.
- 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 list of possible outbound ip address.
- 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_credentialblock 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,
ftp_publish_basic_authentication_enabled: Optional[bool] = None,
hosting_environment_id: Optional[str] = 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,
public_network_access_enabled: Optional[bool] = 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_backup_restore_enabled: Optional[bool] = None,
virtual_network_subnet_id: Optional[str] = None,
webdeploy_publish_basic_authentication_enabled: Optional[bool] = None,
zip_deploy_file: Optional[str] = None) -> WindowsWebAppfunc 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)resources: _: type: azure:appservice:WindowsWebApp get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- App
Settings Dictionary<string, string> - A map of key-value pairs of App Settings.
- Auth
Settings WindowsWeb App Auth Settings - An
auth_settingsblock as defined below. - Auth
Settings WindowsV2 Web App Auth Settings V2 - An
auth_settings_v2block as defined below. - Backup
Windows
Web App Backup - A
backupblock 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_enabledisfalse. Defaults toRequired. - Connection
Strings List<WindowsWeb App Connection String> - One or more
connection_stringblocks 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. - Ftp
Publish boolBasic Authentication Enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - Hosting
Environment stringId - The ID of the App Service Environment used by App Service.
- Https
Only bool - Should the Windows Web App require HTTPS connections. Defaults to
false. - Identity
Windows
Web App Identity - An
identityblock as defined below. - Key
Vault stringReference Identity Id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. For more information see - Access vaults with a user-assigned identity - Kind string
- The Kind value for this Windows 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 - A
logsblock 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 list of possible outbound ip address.
- 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. - Public
Network boolAccess Enabled - Should public network access be enabled for the Web App. Defaults to
true. - 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 - A
site_configblock as defined below. - Site
Credentials List<WindowsWeb App Site Credential> - A
site_credentialblock as defined below. - Sticky
Settings WindowsWeb App Sticky Settings - A
sticky_settingsblock as defined below. - Storage
Accounts List<WindowsWeb App Storage Account> One or more
storage_accountblocks as defined below.Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.- Dictionary<string, string>
- A mapping of tags which should be assigned to the Windows Web App.
- Virtual
Network boolBackup Restore Enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - Virtual
Network stringSubnet Id - Webdeploy
Publish boolBasic Authentication Enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- Zip
Deploy stringFile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
Note: Using this value requires either
WEBSITE_RUN_FROM_PACKAGE=1orSCM_DO_BUILD_DURING_DEPLOYMENT=trueto be set on the App inapp_settings. Refer to the Azure docs on running the Web App directly from the Zip package, or automating the build for Zip deploy for further details.
- App
Settings map[string]string - A map of key-value pairs of App Settings.
- Auth
Settings WindowsWeb App Auth Settings Args - An
auth_settingsblock as defined below. - Auth
Settings WindowsV2 Web App Auth Settings V2Args - An
auth_settings_v2block as defined below. - Backup
Windows
Web App Backup Args - A
backupblock 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_enabledisfalse. Defaults toRequired. - Connection
Strings []WindowsWeb App Connection String Args - One or more
connection_stringblocks 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. - Ftp
Publish boolBasic Authentication Enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - Hosting
Environment stringId - The ID of the App Service Environment used by App Service.
- Https
Only bool - Should the Windows Web App require HTTPS connections. Defaults to
false. - Identity
Windows
Web App Identity Args - An
identityblock as defined below. - Key
Vault stringReference Identity Id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. For more information see - Access vaults with a user-assigned identity - Kind string
- The Kind value for this Windows 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
logsblock 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 list of possible outbound ip address.
- 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. - Public
Network boolAccess Enabled - Should public network access be enabled for the Web App. Defaults to
true. - 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_configblock as defined below. - Site
Credentials []WindowsWeb App Site Credential Args - A
site_credentialblock as defined below. - Sticky
Settings WindowsWeb App Sticky Settings Args - A
sticky_settingsblock as defined below. - Storage
Accounts []WindowsWeb App Storage Account Args One or more
storage_accountblocks as defined below.Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.- map[string]string
- A mapping of tags which should be assigned to the Windows Web App.
- Virtual
Network boolBackup Restore Enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - Virtual
Network stringSubnet Id - Webdeploy
Publish boolBasic Authentication Enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- Zip
Deploy stringFile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
Note: Using this value requires either
WEBSITE_RUN_FROM_PACKAGE=1orSCM_DO_BUILD_DURING_DEPLOYMENT=trueto be set on the App inapp_settings. Refer to the Azure docs on running the Web App directly from the Zip package, or automating the build for Zip deploy for further details.
- app
Settings Map<String,String> - A map of key-value pairs of App Settings.
- auth
Settings WindowsWeb App Auth Settings - An
auth_settingsblock as defined below. - auth
Settings WindowsV2 Web App Auth Settings V2 - An
auth_settings_v2block as defined below. - backup
Windows
Web App Backup - A
backupblock 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_enabledisfalse. Defaults toRequired. - connection
Strings List<WindowsWeb App Connection String> - One or more
connection_stringblocks 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. - ftp
Publish BooleanBasic Authentication Enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - hosting
Environment StringId - The ID of the App Service Environment used by App Service.
- https
Only Boolean - Should the Windows Web App require HTTPS connections. Defaults to
false. - identity
Windows
Web App Identity - An
identityblock as defined below. - key
Vault StringReference Identity Id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. For more information see - Access vaults with a user-assigned identity - kind String
- The Kind value for this Windows 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 - A
logsblock 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 list of possible outbound ip address.
- 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. - public
Network BooleanAccess Enabled - Should public network access be enabled for the Web App. Defaults to
true. - 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 - A
site_configblock as defined below. - site
Credentials List<WindowsWeb App Site Credential> - A
site_credentialblock as defined below. - sticky
Settings WindowsWeb App Sticky Settings - A
sticky_settingsblock as defined below. - storage
Accounts List<WindowsWeb App Storage Account> One or more
storage_accountblocks as defined below.Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.- Map<String,String>
- A mapping of tags which should be assigned to the Windows Web App.
- virtual
Network BooleanBackup Restore Enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - virtual
Network StringSubnet Id - webdeploy
Publish BooleanBasic Authentication Enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- zip
Deploy StringFile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
Note: Using this value requires either
WEBSITE_RUN_FROM_PACKAGE=1orSCM_DO_BUILD_DURING_DEPLOYMENT=trueto be set on the App inapp_settings. Refer to the Azure docs on running the Web App directly from the Zip package, or automating the build for Zip deploy for further details.
- app
Settings {[key: string]: string} - A map of key-value pairs of App Settings.
- auth
Settings WindowsWeb App Auth Settings - An
auth_settingsblock as defined below. - auth
Settings WindowsV2 Web App Auth Settings V2 - An
auth_settings_v2block as defined below. - backup
Windows
Web App Backup - A
backupblock 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_enabledisfalse. Defaults toRequired. - connection
Strings WindowsWeb App Connection String[] - One or more
connection_stringblocks 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. - ftp
Publish booleanBasic Authentication Enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - hosting
Environment stringId - The ID of the App Service Environment used by App Service.
- https
Only boolean - Should the Windows Web App require HTTPS connections. Defaults to
false. - identity
Windows
Web App Identity - An
identityblock as defined below. - key
Vault stringReference Identity Id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. For more information see - Access vaults with a user-assigned identity - kind string
- The Kind value for this Windows 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 - A
logsblock 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 list of possible outbound ip address.
- 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. - public
Network booleanAccess Enabled - Should public network access be enabled for the Web App. Defaults to
true. - 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 - A
site_configblock as defined below. - site
Credentials WindowsWeb App Site Credential[] - A
site_credentialblock as defined below. - sticky
Settings WindowsWeb App Sticky Settings - A
sticky_settingsblock as defined below. - storage
Accounts WindowsWeb App Storage Account[] One or more
storage_accountblocks as defined below.Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.- {[key: string]: string}
- A mapping of tags which should be assigned to the Windows Web App.
- virtual
Network booleanBackup Restore Enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - virtual
Network stringSubnet Id - webdeploy
Publish booleanBasic Authentication Enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- zip
Deploy stringFile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
Note: Using this value requires either
WEBSITE_RUN_FROM_PACKAGE=1orSCM_DO_BUILD_DURING_DEPLOYMENT=trueto be set on the App inapp_settings. Refer to the Azure docs on running the Web App directly from the Zip package, or automating the build for Zip deploy for further details.
- app_
settings Mapping[str, str] - A map of key-value pairs of App Settings.
- auth_
settings WindowsWeb App Auth Settings Args - An
auth_settingsblock as defined below. - auth_
settings_ Windowsv2 Web App Auth Settings V2Args - An
auth_settings_v2block as defined below. - backup
Windows
Web App Backup Args - A
backupblock 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_enabledisfalse. Defaults toRequired. - connection_
strings Sequence[WindowsWeb App Connection String Args] - One or more
connection_stringblocks 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. - ftp_
publish_ boolbasic_ authentication_ enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - hosting_
environment_ strid - The ID of the App Service Environment used by App Service.
- https_
only bool - Should the Windows Web App require HTTPS connections. Defaults to
false. - identity
Windows
Web App Identity Args - An
identityblock as defined below. - key_
vault_ strreference_ identity_ id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. For more information see - Access vaults with a user-assigned identity - kind str
- The Kind value for this Windows 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
logsblock 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 list of possible outbound ip address.
- 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. - public_
network_ boolaccess_ enabled - Should public network access be enabled for the Web App. Defaults to
true. - 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_configblock as defined below. - site_
credentials Sequence[WindowsWeb App Site Credential Args] - A
site_credentialblock as defined below. - sticky_
settings WindowsWeb App Sticky Settings Args - A
sticky_settingsblock as defined below. - storage_
accounts Sequence[WindowsWeb App Storage Account Args] One or more
storage_accountblocks as defined below.Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.- Mapping[str, str]
- A mapping of tags which should be assigned to the Windows Web App.
- virtual_
network_ boolbackup_ restore_ enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - virtual_
network_ strsubnet_ id - webdeploy_
publish_ boolbasic_ authentication_ enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- zip_
deploy_ strfile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
Note: Using this value requires either
WEBSITE_RUN_FROM_PACKAGE=1orSCM_DO_BUILD_DURING_DEPLOYMENT=trueto be set on the App inapp_settings. Refer to the Azure docs on running the Web App directly from the Zip package, or automating the build for Zip deploy for further details.
- app
Settings Map<String> - A map of key-value pairs of App Settings.
- auth
Settings Property Map - An
auth_settingsblock as defined below. - auth
Settings Property MapV2 - An
auth_settings_v2block as defined below. - backup Property Map
- A
backupblock 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_enabledisfalse. Defaults toRequired. - connection
Strings List<Property Map> - One or more
connection_stringblocks 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. - ftp
Publish BooleanBasic Authentication Enabled - Should the default FTP Basic Authentication publishing profile be enabled. Defaults to
true. - hosting
Environment StringId - The ID of the App Service Environment used by App Service.
- https
Only Boolean - Should the Windows Web App require HTTPS connections. Defaults to
false. - identity Property Map
- An
identityblock as defined below. - key
Vault StringReference Identity Id - The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the
identityblock. For more information see - Access vaults with a user-assigned identity - kind String
- The Kind value for this Windows 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
logsblock 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 list of possible outbound ip address.
- 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. - public
Network BooleanAccess Enabled - Should public network access be enabled for the Web App. Defaults to
true. - 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_configblock as defined below. - site
Credentials List<Property Map> - A
site_credentialblock as defined below. - sticky
Settings Property Map - A
sticky_settingsblock as defined below. - storage
Accounts List<Property Map> One or more
storage_accountblocks as defined below.Note: Using this value requires
WEBSITE_RUN_FROM_PACKAGE=1to be set on the App inapp_settings. Refer to the Azure docs for further details.- Map<String>
- A mapping of tags which should be assigned to the Windows Web App.
- virtual
Network BooleanBackup Restore Enabled - Whether backup and restore operations over the linked virtual network are enabled. Defaults to
false. - virtual
Network StringSubnet Id - webdeploy
Publish BooleanBasic Authentication Enabled Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to
true.NOTE: Setting this value to true will disable the ability to use
zip_deploy_filewhich currently relies on the default publishing profile.- zip
Deploy StringFile The local path and filename of the Zip packaged application to deploy to this Windows Web App.
Note: Using this value requires either
WEBSITE_RUN_FROM_PACKAGE=1orSCM_DO_BUILD_DURING_DEPLOYMENT=trueto be set on the App inapp_settings. Refer to the Azure docs on running the Web App directly from the Zip package, or automating the build for Zip deploy for further details.
Supporting Types
WindowsWebAppAuthSettings, WindowsWebAppAuthSettingsArgs
- 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_directoryblock as defined above. - Additional
Login Dictionary<string, string>Parameters - Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.
- Allowed
External List<string>Redirect Urls - Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Windows Web App.
- Default
Provider string The default authentication provider to use when multiple providers are configured. Possible values include:
AzureActiveDirectory,Facebook,Google,MicrosoftAccount,Twitter,GithubNOTE: This setting is only needed if multiple providers are configured, and the
unauthenticated_client_actionis set to "RedirectToLoginPage".- Facebook
Windows
Web App Auth Settings Facebook - A
facebookblock as defined below. - Github
Windows
Web App Auth Settings Github - A
githubblock as defined below. - Google
Windows
Web App Auth Settings Google - A
googleblock as defined below. - Issuer string
The OpenID Connect Issuer URI that represents the entity which issues access tokens for this Windows Web App.
NOTE: When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
- Microsoft
Windows
Web App Auth Settings Microsoft - A
microsoftblock as defined below. - Runtime
Version string - The RuntimeVersion of the Authentication / Authorization feature in use for the Windows Web App.
- Token
Refresh doubleExtension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - Token
Store boolEnabled - Should the Windows 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
twitterblock as defined below. - Unauthenticated
Client stringAction - The action to take when an unauthenticated client attempts to access the app. Possible values include:
RedirectToLoginPage,AllowAnonymous.
- Enabled bool
- Should the Authentication / Authorization feature is enabled for the Windows Web App be enabled?
- Active
Directory WindowsWeb App Auth Settings Active Directory - An
active_directoryblock as defined above. - Additional
Login map[string]stringParameters - Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.
- Allowed
External []stringRedirect Urls - Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Windows Web App.
- Default
Provider string The default authentication provider to use when multiple providers are configured. Possible values include:
AzureActiveDirectory,Facebook,Google,MicrosoftAccount,Twitter,GithubNOTE: This setting is only needed if multiple providers are configured, and the
unauthenticated_client_actionis set to "RedirectToLoginPage".- Facebook
Windows
Web App Auth Settings Facebook - A
facebookblock as defined below. - Github
Windows
Web App Auth Settings Github - A
githubblock as defined below. - Google
Windows
Web App Auth Settings Google - A
googleblock as defined below. - Issuer string
The OpenID Connect Issuer URI that represents the entity which issues access tokens for this Windows Web App.
NOTE: When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
- Microsoft
Windows
Web App Auth Settings Microsoft - A
microsoftblock as defined below. - Runtime
Version string - The RuntimeVersion of the Authentication / Authorization feature in use for the Windows Web App.
- Token
Refresh float64Extension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - Token
Store boolEnabled - Should the Windows 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
twitterblock as defined below. - Unauthenticated
Client stringAction - The action to take when an unauthenticated client attempts to access the app. Possible values include:
RedirectToLoginPage,AllowAnonymous.
- enabled Boolean
- Should the Authentication / Authorization feature is enabled for the Windows Web App be enabled?
- active
Directory WindowsWeb App Auth Settings Active Directory - An
active_directoryblock as defined above. - additional
Login Map<String,String>Parameters - Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.
- allowed
External List<String>Redirect Urls - Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Windows Web App.
- default
Provider String The default authentication provider to use when multiple providers are configured. Possible values include:
AzureActiveDirectory,Facebook,Google,MicrosoftAccount,Twitter,GithubNOTE: This setting is only needed if multiple providers are configured, and the
unauthenticated_client_actionis set to "RedirectToLoginPage".- facebook
Windows
Web App Auth Settings Facebook - A
facebookblock as defined below. - github
Windows
Web App Auth Settings Github - A
githubblock as defined below. - google
Windows
Web App Auth Settings Google - A
googleblock as defined below. - issuer String
The OpenID Connect Issuer URI that represents the entity which issues access tokens for this Windows Web App.
NOTE: When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
- microsoft
Windows
Web App Auth Settings Microsoft - A
microsoftblock as defined below. - runtime
Version String - The RuntimeVersion of the Authentication / Authorization feature in use for the Windows Web App.
- token
Refresh DoubleExtension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - token
Store BooleanEnabled - Should the Windows 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
twitterblock as defined below. - unauthenticated
Client StringAction - The action to take when an unauthenticated client attempts to access the app. Possible values include:
RedirectToLoginPage,AllowAnonymous.
- enabled boolean
- Should the Authentication / Authorization feature is enabled for the Windows Web App be enabled?
- active
Directory WindowsWeb App Auth Settings Active Directory - An
active_directoryblock as defined above. - additional
Login {[key: string]: string}Parameters - Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.
- allowed
External string[]Redirect Urls - Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Windows Web App.
- default
Provider string The default authentication provider to use when multiple providers are configured. Possible values include:
AzureActiveDirectory,Facebook,Google,MicrosoftAccount,Twitter,GithubNOTE: This setting is only needed if multiple providers are configured, and the
unauthenticated_client_actionis set to "RedirectToLoginPage".- facebook
Windows
Web App Auth Settings Facebook - A
facebookblock as defined below. - github
Windows
Web App Auth Settings Github - A
githubblock as defined below. - google
Windows
Web App Auth Settings Google - A
googleblock as defined below. - issuer string
The OpenID Connect Issuer URI that represents the entity which issues access tokens for this Windows Web App.
NOTE: When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
- microsoft
Windows
Web App Auth Settings Microsoft - A
microsoftblock as defined below. - runtime
Version string - The RuntimeVersion of the Authentication / Authorization feature in use for the Windows Web App.
- token
Refresh numberExtension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - token
Store booleanEnabled - Should the Windows 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
twitterblock as defined below. - unauthenticated
Client stringAction - The action to take when an unauthenticated client attempts to access the app. Possible values include:
RedirectToLoginPage,AllowAnonymous.
- enabled bool
- Should the Authentication / Authorization feature is enabled for the Windows Web App be enabled?
- active_
directory WindowsWeb App Auth Settings Active Directory - An
active_directoryblock as defined above. - additional_
login_ Mapping[str, str]parameters - Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.
- allowed_
external_ Sequence[str]redirect_ urls - Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Windows Web App.
- default_
provider str The default authentication provider to use when multiple providers are configured. Possible values include:
AzureActiveDirectory,Facebook,Google,MicrosoftAccount,Twitter,GithubNOTE: This setting is only needed if multiple providers are configured, and the
unauthenticated_client_actionis set to "RedirectToLoginPage".- facebook
Windows
Web App Auth Settings Facebook - A
facebookblock as defined below. - github
Windows
Web App Auth Settings Github - A
githubblock as defined below. - google
Windows
Web App Auth Settings Google - A
googleblock as defined below. - issuer str
The OpenID Connect Issuer URI that represents the entity which issues access tokens for this Windows Web App.
NOTE: When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
- microsoft
Windows
Web App Auth Settings Microsoft - A
microsoftblock as defined below. - runtime_
version str - The RuntimeVersion of the Authentication / Authorization feature in use for the Windows Web App.
- token_
refresh_ floatextension_ hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - token_
store_ boolenabled - Should the Windows 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
twitterblock as defined below. - unauthenticated_
client_ straction - The action to take when an unauthenticated client attempts to access the app. Possible values include:
RedirectToLoginPage,AllowAnonymous.
- enabled Boolean
- Should the Authentication / Authorization feature is enabled for the Windows Web App be enabled?
- active
Directory Property Map - An
active_directoryblock as defined above. - additional
Login Map<String>Parameters - Specifies a map of login Parameters to send to the OpenID Connect authorization endpoint when a user logs in.
- allowed
External List<String>Redirect Urls - Specifies a list of External URLs that can be redirected to as part of logging in or logging out of the Windows Web App.
- default
Provider String The default authentication provider to use when multiple providers are configured. Possible values include:
AzureActiveDirectory,Facebook,Google,MicrosoftAccount,Twitter,GithubNOTE: This setting is only needed if multiple providers are configured, and the
unauthenticated_client_actionis set to "RedirectToLoginPage".- facebook Property Map
- A
facebookblock as defined below. - github Property Map
- A
githubblock as defined below. - google Property Map
- A
googleblock as defined below. - issuer String
The OpenID Connect Issuer URI that represents the entity which issues access tokens for this Windows Web App.
NOTE: When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
- microsoft Property Map
- A
microsoftblock as defined below. - runtime
Version String - The RuntimeVersion of the Authentication / Authorization feature in use for the Windows Web App.
- token
Refresh NumberExtension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - token
Store BooleanEnabled - Should the Windows Web App durably store platform-specific security tokens that are obtained during login flows? Defaults to
false. - twitter Property Map
- A
twitterblock as defined below. - unauthenticated
Client StringAction - The action to take when an unauthenticated client attempts to access the app. Possible values include:
RedirectToLoginPage,AllowAnonymous.
WindowsWebAppAuthSettingsActiveDirectory, WindowsWebAppAuthSettingsActiveDirectoryArgs
- Client
Id string - The ID of the Client to use to authenticate with Azure Active Directory.
- Allowed
Audiences List<string> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
Note: The
client_idvalue is always considered an allowed audience.- Client
Secret string - The Client Secret for the Client ID. Cannot be used with
client_secret_setting_name. - Client
Secret stringSetting Name - The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret.
- Client
Id string - The ID of the Client to use to authenticate with Azure Active Directory.
- Allowed
Audiences []string Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
Note: The
client_idvalue is always considered an allowed audience.- Client
Secret string - The Client Secret for the Client ID. Cannot be used with
client_secret_setting_name. - Client
Secret stringSetting Name - The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret.
- client
Id String - The ID of the Client to use to authenticate with Azure Active Directory.
- allowed
Audiences List<String> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
Note: The
client_idvalue is always considered an allowed audience.- client
Secret String - The Client Secret for the Client ID. Cannot be used with
client_secret_setting_name. - client
Secret StringSetting Name - The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret.
- client
Id string - The ID of the Client to use to authenticate with Azure Active Directory.
- allowed
Audiences string[] Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
Note: The
client_idvalue is always considered an allowed audience.- client
Secret string - The Client Secret for the Client ID. Cannot be used with
client_secret_setting_name. - client
Secret stringSetting Name - The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret.
- client_
id str - The ID of the Client to use to authenticate with Azure Active Directory.
- allowed_
audiences Sequence[str] Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
Note: The
client_idvalue is always considered an allowed audience.- client_
secret str - The Client Secret for the Client ID. Cannot be used with
client_secret_setting_name. - client_
secret_ strsetting_ name - The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret.
- client
Id String - The ID of the Client to use to authenticate with Azure Active Directory.
- allowed
Audiences List<String> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
Note: The
client_idvalue is always considered an allowed audience.- client
Secret String - The Client Secret for the Client ID. Cannot be used with
client_secret_setting_name. - client
Secret StringSetting Name - The App Setting name that contains the client secret of the Client. Cannot be used with
client_secret.
WindowsWebAppAuthSettingsFacebook, WindowsWebAppAuthSettingsFacebookArgs
- App
Id string - The App ID of the Facebook app used for login.
- App
Secret string - The App Secret of the Facebook app used for Facebook login. Cannot be specified with
app_secret_setting_name. - App
Secret stringSetting Name - The app setting name that contains the
app_secretvalue used for Facebook login. Cannot be specified withapp_secret. - Oauth
Scopes List<string> - Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.
- App
Id string - The App ID of the Facebook app used for login.
- App
Secret string - The App Secret of the Facebook app used for Facebook login. Cannot be specified with
app_secret_setting_name. - App
Secret stringSetting Name - The app setting name that contains the
app_secretvalue used for Facebook login. Cannot be specified withapp_secret. - Oauth
Scopes []string - Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.
- app
Id String - The App ID of the Facebook app used for login.
- app
Secret String - The App Secret of the Facebook app used for Facebook login. Cannot be specified with
app_secret_setting_name. - app
Secret StringSetting Name - The app setting name that contains the
app_secretvalue used for Facebook login. Cannot be specified withapp_secret. - oauth
Scopes List<String> - Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.
- app
Id string - The App ID of the Facebook app used for login.
- app
Secret string - The App Secret of the Facebook app used for Facebook login. Cannot be specified with
app_secret_setting_name. - app
Secret stringSetting Name - The app setting name that contains the
app_secretvalue used for Facebook login. Cannot be specified withapp_secret. - oauth
Scopes string[] - Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.
- app_
id str - The App ID of the Facebook app used for login.
- app_
secret str - The App Secret of the Facebook app used for Facebook login. Cannot be specified with
app_secret_setting_name. - app_
secret_ strsetting_ name - The app setting name that contains the
app_secretvalue used for Facebook login. Cannot be specified withapp_secret. - oauth_
scopes Sequence[str] - Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.
- app
Id String - The App ID of the Facebook app used for login.
- app
Secret String - The App Secret of the Facebook app used for Facebook login. Cannot be specified with
app_secret_setting_name. - app
Secret StringSetting Name - The app setting name that contains the
app_secretvalue used for Facebook login. Cannot be specified withapp_secret. - oauth
Scopes List<String> - Specifies a list of OAuth 2.0 scopes to be requested as part of Facebook login authentication.
WindowsWebAppAuthSettingsGithub, WindowsWebAppAuthSettingsGithubArgs
- Client
Id string - The ID of the GitHub app used for login.
- Client
Secret string - The Client Secret of the GitHub app used for GitHub login. Cannot be specified with
client_secret_setting_name. - Client
Secret stringSetting Name - The app setting name that contains the
client_secretvalue used for GitHub login. Cannot be specified withclient_secret. - Oauth
Scopes List<string> - Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.
- Client
Id string - The ID of the GitHub app used for login.
- Client
Secret string - The Client Secret of the GitHub app used for GitHub login. Cannot be specified with
client_secret_setting_name. - Client
Secret stringSetting Name - The app setting name that contains the
client_secretvalue used for GitHub login. Cannot be specified withclient_secret. - Oauth
Scopes []string - Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.
- client
Id String - The ID of the GitHub app used for login.
- client
Secret String - The Client Secret of the GitHub app used for GitHub login. Cannot be specified with
client_secret_setting_name. - client
Secret StringSetting Name - The app setting name that contains the
client_secretvalue used for GitHub login. Cannot be specified withclient_secret. - oauth
Scopes List<String> - Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.
- client
Id string - The ID of the GitHub app used for login.
- client
Secret string - The Client Secret of the GitHub app used for GitHub login. Cannot be specified with
client_secret_setting_name. - client
Secret stringSetting Name - The app setting name that contains the
client_secretvalue used for GitHub login. Cannot be specified withclient_secret. - oauth
Scopes string[] - Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.
- client_
id str - The ID of the GitHub app used for login.
- client_
secret str - The Client Secret of the GitHub app used for GitHub login. Cannot be specified with
client_secret_setting_name. - client_
secret_ strsetting_ name - The app setting name that contains the
client_secretvalue used for GitHub login. Cannot be specified withclient_secret. - oauth_
scopes Sequence[str] - Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.
- client
Id String - The ID of the GitHub app used for login.
- client
Secret String - The Client Secret of the GitHub app used for GitHub login. Cannot be specified with
client_secret_setting_name. - client
Secret StringSetting Name - The app setting name that contains the
client_secretvalue used for GitHub login. Cannot be specified withclient_secret. - oauth
Scopes List<String> - Specifies a list of OAuth 2.0 scopes that will be requested as part of GitHub login authentication.
WindowsWebAppAuthSettingsGoogle, WindowsWebAppAuthSettingsGoogleArgs
- Client
Id string - The OpenID Connect Client ID for the Google web application.
- Client
Secret string - The client secret associated with the Google web application. Cannot be specified with
client_secret_setting_name. - Client
Secret stringSetting Name - The app setting name that contains the
client_secretvalue used for Google login. Cannot be specified withclient_secret. - Oauth
Scopes List<string> - Specifies a list of OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. If not specified,
openid,profile, andemailare used as default scopes.
- Client
Id string - The OpenID Connect Client ID for the Google web application.
- Client
Secret string - The client secret associated with the Google web application. Cannot be specified with
client_secret_setting_name. - Client
Secret stringSetting Name - The app setting name that contains the
client_secretvalue used for Google login. Cannot be specified withclient_secret. - Oauth
Scopes []string - Specifies a list of OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. If not specified,
openid,profile, andemailare used as default scopes.
- client
Id String - The OpenID Connect Client ID for the Google web application.
- client
Secret String - The client secret associated with the Google web application. Cannot be specified with
client_secret_setting_name. - client
Secret StringSetting Name - The app setting name that contains the
client_secretvalue used for Google login. Cannot be specified withclient_secret. - oauth
Scopes List<String> - Specifies a list of OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. If not specified,
openid,profile, andemailare used as default scopes.
- client
Id string - The OpenID Connect Client ID for the Google web application.
- client
Secret string - The client secret associated with the Google web application. Cannot be specified with
client_secret_setting_name. - client
Secret stringSetting Name - The app setting name that contains the
client_secretvalue used for Google login. Cannot be specified withclient_secret. - oauth
Scopes string[] - Specifies a list of OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. If not specified,
openid,profile, andemailare used as default scopes.
- client_
id str - The OpenID Connect Client ID for the Google web application.
- client_
secret str - The client secret associated with the Google web application. Cannot be specified with
client_secret_setting_name. - client_
secret_ strsetting_ name - The app setting name that contains the
client_secretvalue used for Google login. Cannot be specified withclient_secret. - oauth_
scopes Sequence[str] - Specifies a list of OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. If not specified,
openid,profile, andemailare used as default scopes.
- client
Id String - The OpenID Connect Client ID for the Google web application.
- client
Secret String - The client secret associated with the Google web application. Cannot be specified with
client_secret_setting_name. - client
Secret StringSetting Name - The app setting name that contains the
client_secretvalue used for Google login. Cannot be specified withclient_secret. - oauth
Scopes List<String> - Specifies a list of OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. If not specified,
openid,profile, andemailare used as default scopes.
WindowsWebAppAuthSettingsMicrosoft, WindowsWebAppAuthSettingsMicrosoftArgs
- 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, WindowsWebAppAuthSettingsTwitterArgs
- 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, WindowsWebAppAuthSettingsV2Args
- Login
Windows
Web App Auth Settings V2Login - A
loginblock as defined below. - Active
Directory WindowsV2 Web App Auth Settings V2Active Directory V2 - An
active_directory_v2block as defined below. - Apple
V2 WindowsWeb App Auth Settings V2Apple V2 - An
apple_v2block as defined below. - Auth
Enabled bool - Should the AuthV2 Settings be enabled. Defaults to
false. - Azure
Static WindowsWeb App V2 Web App Auth Settings V2Azure Static Web App V2 - An
azure_static_web_app_v2block as defined below. - Config
File stringPath The path to the App Auth settings.
Note: Relative Paths are evaluated from the Site Root directory.
- Custom
Oidc List<WindowsV2s Web App Auth Settings V2Custom Oidc V2> - Zero or more
custom_oidc_v2blocks as defined below. - Default
Provider string The Default Authentication Provider to use when the
unauthenticated_actionis set toRedirectToLoginPage. Possible values include:apple,azureactivedirectory,facebook,github,google,twitterand thenameof yourcustom_oidc_v2provider.NOTE: Whilst any value will be accepted by the API for
default_provider, it can leave the app in an unusable state if this value does not correspond to the name of a known provider (either built-in value, or custom_oidc name) as it is used to build the auth endpoint URI.- Excluded
Paths List<string> The paths which should be excluded from the
unauthenticated_actionwhen it is set toRedirectToLoginPage.NOTE: This list should be used instead of setting
WEBSITE_WARMUP_PATHinapp_settingsas it takes priority.- Facebook
V2 WindowsWeb App Auth Settings V2Facebook V2 - A
facebook_v2block as defined below. - Forward
Proxy stringConvention - The convention used to determine the url of the request made. Possible values include
NoProxy,Standard,Custom. Defaults toNoProxy. - Forward
Proxy stringCustom Host Header Name - The name of the custom header containing the host of the request.
- Forward
Proxy stringCustom Scheme Header Name - The name of the custom header containing the scheme of the request.
- Github
V2 WindowsWeb App Auth Settings V2Github V2 - A
github_v2block as defined below. - Google
V2 WindowsWeb App Auth Settings V2Google V2 - A
google_v2block as defined below. - Http
Route stringApi Prefix - The prefix that should precede all the authentication and authorisation paths. Defaults to
/.auth. - Microsoft
V2 WindowsWeb App Auth Settings V2Microsoft V2 - A
microsoft_v2block as defined below. - Require
Authentication bool - Should the authentication flow be used for all requests.
- Require
Https bool - Should HTTPS be required on connections? Defaults to
true. - Runtime
Version string - The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to
~1. - Twitter
V2 WindowsWeb App Auth Settings V2Twitter V2 - A
twitter_v2block as defined below. - Unauthenticated
Action string - The action to take for requests made without authentication. Possible values include
RedirectToLoginPage,AllowAnonymous,Return401, andReturn403. Defaults toRedirectToLoginPage.
- Login
Windows
Web App Auth Settings V2Login - A
loginblock as defined below. - Active
Directory WindowsV2 Web App Auth Settings V2Active Directory V2 - An
active_directory_v2block as defined below. - Apple
V2 WindowsWeb App Auth Settings V2Apple V2 - An
apple_v2block as defined below. - Auth
Enabled bool - Should the AuthV2 Settings be enabled. Defaults to
false. - Azure
Static WindowsWeb App V2 Web App Auth Settings V2Azure Static Web App V2 - An
azure_static_web_app_v2block as defined below. - Config
File stringPath The path to the App Auth settings.
Note: Relative Paths are evaluated from the Site Root directory.
- Custom
Oidc []WindowsV2s Web App Auth Settings V2Custom Oidc V2 - Zero or more
custom_oidc_v2blocks as defined below. - Default
Provider string The Default Authentication Provider to use when the
unauthenticated_actionis set toRedirectToLoginPage. Possible values include:apple,azureactivedirectory,facebook,github,google,twitterand thenameof yourcustom_oidc_v2provider.NOTE: Whilst any value will be accepted by the API for
default_provider, it can leave the app in an unusable state if this value does not correspond to the name of a known provider (either built-in value, or custom_oidc name) as it is used to build the auth endpoint URI.- Excluded
Paths []string The paths which should be excluded from the
unauthenticated_actionwhen it is set toRedirectToLoginPage.NOTE: This list should be used instead of setting
WEBSITE_WARMUP_PATHinapp_settingsas it takes priority.- Facebook
V2 WindowsWeb App Auth Settings V2Facebook V2 - A
facebook_v2block as defined below. - Forward
Proxy stringConvention - The convention used to determine the url of the request made. Possible values include
NoProxy,Standard,Custom. Defaults toNoProxy. - Forward
Proxy stringCustom Host Header Name - The name of the custom header containing the host of the request.
- Forward
Proxy stringCustom Scheme Header Name - The name of the custom header containing the scheme of the request.
- Github
V2 WindowsWeb App Auth Settings V2Github V2 - A
github_v2block as defined below. - Google
V2 WindowsWeb App Auth Settings V2Google V2 - A
google_v2block as defined below. - Http
Route stringApi Prefix - The prefix that should precede all the authentication and authorisation paths. Defaults to
/.auth. - Microsoft
V2 WindowsWeb App Auth Settings V2Microsoft V2 - A
microsoft_v2block as defined below. - Require
Authentication bool - Should the authentication flow be used for all requests.
- Require
Https bool - Should HTTPS be required on connections? Defaults to
true. - Runtime
Version string - The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to
~1. - Twitter
V2 WindowsWeb App Auth Settings V2Twitter V2 - A
twitter_v2block as defined below. - Unauthenticated
Action string - The action to take for requests made without authentication. Possible values include
RedirectToLoginPage,AllowAnonymous,Return401, andReturn403. Defaults toRedirectToLoginPage.
- login
Windows
Web App Auth Settings V2Login - A
loginblock as defined below. - active
Directory WindowsV2 Web App Auth Settings V2Active Directory V2 - An
active_directory_v2block as defined below. - apple
V2 WindowsWeb App Auth Settings V2Apple V2 - An
apple_v2block as defined below. - auth
Enabled Boolean - Should the AuthV2 Settings be enabled. Defaults to
false. - azure
Static WindowsWeb App V2 Web App Auth Settings V2Azure Static Web App V2 - An
azure_static_web_app_v2block as defined below. - config
File StringPath The path to the App Auth settings.
Note: Relative Paths are evaluated from the Site Root directory.
- custom
Oidc List<WindowsV2s Web App Auth Settings V2Custom Oidc V2> - Zero or more
custom_oidc_v2blocks as defined below. - default
Provider String The Default Authentication Provider to use when the
unauthenticated_actionis set toRedirectToLoginPage. Possible values include:apple,azureactivedirectory,facebook,github,google,twitterand thenameof yourcustom_oidc_v2provider.NOTE: Whilst any value will be accepted by the API for
default_provider, it can leave the app in an unusable state if this value does not correspond to the name of a known provider (either built-in value, or custom_oidc name) as it is used to build the auth endpoint URI.- excluded
Paths List<String> The paths which should be excluded from the
unauthenticated_actionwhen it is set toRedirectToLoginPage.NOTE: This list should be used instead of setting
WEBSITE_WARMUP_PATHinapp_settingsas it takes priority.- facebook
V2 WindowsWeb App Auth Settings V2Facebook V2 - A
facebook_v2block as defined below. - forward
Proxy StringConvention - The convention used to determine the url of the request made. Possible values include
NoProxy,Standard,Custom. Defaults toNoProxy. - forward
Proxy StringCustom Host Header Name - The name of the custom header containing the host of the request.
- forward
Proxy StringCustom Scheme Header Name - The name of the custom header containing the scheme of the request.
- github
V2 WindowsWeb App Auth Settings V2Github V2 - A
github_v2block as defined below. - google
V2 WindowsWeb App Auth Settings V2Google V2 - A
google_v2block as defined below. - http
Route StringApi Prefix - The prefix that should precede all the authentication and authorisation paths. Defaults to
/.auth. - microsoft
V2 WindowsWeb App Auth Settings V2Microsoft V2 - A
microsoft_v2block as defined below. - require
Authentication Boolean - Should the authentication flow be used for all requests.
- require
Https Boolean - Should HTTPS be required on connections? Defaults to
true. - runtime
Version String - The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to
~1. - twitter
V2 WindowsWeb App Auth Settings V2Twitter V2 - A
twitter_v2block as defined below. - unauthenticated
Action String - The action to take for requests made without authentication. Possible values include
RedirectToLoginPage,AllowAnonymous,Return401, andReturn403. Defaults toRedirectToLoginPage.
- login
Windows
Web App Auth Settings V2Login - A
loginblock as defined below. - active
Directory WindowsV2 Web App Auth Settings V2Active Directory V2 - An
active_directory_v2block as defined below. - apple
V2 WindowsWeb App Auth Settings V2Apple V2 - An
apple_v2block as defined below. - auth
Enabled boolean - Should the AuthV2 Settings be enabled. Defaults to
false. - azure
Static WindowsWeb App V2 Web App Auth Settings V2Azure Static Web App V2 - An
azure_static_web_app_v2block as defined below. - config
File stringPath The path to the App Auth settings.
Note: Relative Paths are evaluated from the Site Root directory.
- custom
Oidc WindowsV2s Web App Auth Settings V2Custom Oidc V2[] - Zero or more
custom_oidc_v2blocks as defined below. - default
Provider string The Default Authentication Provider to use when the
unauthenticated_actionis set toRedirectToLoginPage. Possible values include:apple,azureactivedirectory,facebook,github,google,twitterand thenameof yourcustom_oidc_v2provider.NOTE: Whilst any value will be accepted by the API for
default_provider, it can leave the app in an unusable state if this value does not correspond to the name of a known provider (either built-in value, or custom_oidc name) as it is used to build the auth endpoint URI.- excluded
Paths string[] The paths which should be excluded from the
unauthenticated_actionwhen it is set toRedirectToLoginPage.NOTE: This list should be used instead of setting
WEBSITE_WARMUP_PATHinapp_settingsas it takes priority.- facebook
V2 WindowsWeb App Auth Settings V2Facebook V2 - A
facebook_v2block as defined below. - forward
Proxy stringConvention - The convention used to determine the url of the request made. Possible values include
NoProxy,Standard,Custom. Defaults toNoProxy. - forward
Proxy stringCustom Host Header Name - The name of the custom header containing the host of the request.
- forward
Proxy stringCustom Scheme Header Name - The name of the custom header containing the scheme of the request.
- github
V2 WindowsWeb App Auth Settings V2Github V2 - A
github_v2block as defined below. - google
V2 WindowsWeb App Auth Settings V2Google V2 - A
google_v2block as defined below. - http
Route stringApi Prefix - The prefix that should precede all the authentication and authorisation paths. Defaults to
/.auth. - microsoft
V2 WindowsWeb App Auth Settings V2Microsoft V2 - A
microsoft_v2block as defined below. - require
Authentication boolean - Should the authentication flow be used for all requests.
- require
Https boolean - Should HTTPS be required on connections? Defaults to
true. - runtime
Version string - The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to
~1. - twitter
V2 WindowsWeb App Auth Settings V2Twitter V2 - A
twitter_v2block as defined below. - unauthenticated
Action string - The action to take for requests made without authentication. Possible values include
RedirectToLoginPage,AllowAnonymous,Return401, andReturn403. Defaults toRedirectToLoginPage.
- login
Windows
Web App Auth Settings V2Login - A
loginblock as defined below. - active_
directory_ Windowsv2 Web App Auth Settings V2Active Directory V2 - An
active_directory_v2block as defined below. - apple_
v2 WindowsWeb App Auth Settings V2Apple V2 - An
apple_v2block as defined below. - auth_
enabled bool - Should the AuthV2 Settings be enabled. Defaults to
false. - azure_
static_ Windowsweb_ app_ v2 Web App Auth Settings V2Azure Static Web App V2 - An
azure_static_web_app_v2block as defined below. - config_
file_ strpath The path to the App Auth settings.
Note: Relative Paths are evaluated from the Site Root directory.
- custom_
oidc_ Sequence[Windowsv2s Web App Auth Settings V2Custom Oidc V2] - Zero or more
custom_oidc_v2blocks as defined below. - default_
provider str The Default Authentication Provider to use when the
unauthenticated_actionis set toRedirectToLoginPage. Possible values include:apple,azureactivedirectory,facebook,github,google,twitterand thenameof yourcustom_oidc_v2provider.NOTE: Whilst any value will be accepted by the API for
default_provider, it can leave the app in an unusable state if this value does not correspond to the name of a known provider (either built-in value, or custom_oidc name) as it is used to build the auth endpoint URI.- excluded_
paths Sequence[str] The paths which should be excluded from the
unauthenticated_actionwhen it is set toRedirectToLoginPage.NOTE: This list should be used instead of setting
WEBSITE_WARMUP_PATHinapp_settingsas it takes priority.- facebook_
v2 WindowsWeb App Auth Settings V2Facebook V2 - A
facebook_v2block as defined below. - forward_
proxy_ strconvention - The convention used to determine the url of the request made. Possible values include
NoProxy,Standard,Custom. Defaults toNoProxy. - forward_
proxy_ strcustom_ host_ header_ name - The name of the custom header containing the host of the request.
- forward_
proxy_ strcustom_ scheme_ header_ name - The name of the custom header containing the scheme of the request.
- github_
v2 WindowsWeb App Auth Settings V2Github V2 - A
github_v2block as defined below. - google_
v2 WindowsWeb App Auth Settings V2Google V2 - A
google_v2block as defined below. - http_
route_ strapi_ prefix - The prefix that should precede all the authentication and authorisation paths. Defaults to
/.auth. - microsoft_
v2 WindowsWeb App Auth Settings V2Microsoft V2 - A
microsoft_v2block as defined below. - require_
authentication bool - Should the authentication flow be used for all requests.
- require_
https bool - Should HTTPS be required on connections? Defaults to
true. - runtime_
version str - The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to
~1. - twitter_
v2 WindowsWeb App Auth Settings V2Twitter V2 - A
twitter_v2block as defined below. - unauthenticated_
action str - The action to take for requests made without authentication. Possible values include
RedirectToLoginPage,AllowAnonymous,Return401, andReturn403. Defaults toRedirectToLoginPage.
- login Property Map
- A
loginblock as defined below. - active
Directory Property MapV2 - An
active_directory_v2block as defined below. - apple
V2 Property Map - An
apple_v2block as defined below. - auth
Enabled Boolean - Should the AuthV2 Settings be enabled. Defaults to
false. - azure
Static Property MapWeb App V2 - An
azure_static_web_app_v2block as defined below. - config
File StringPath The path to the App Auth settings.
Note: Relative Paths are evaluated from the Site Root directory.
- custom
Oidc List<Property Map>V2s - Zero or more
custom_oidc_v2blocks as defined below. - default
Provider String The Default Authentication Provider to use when the
unauthenticated_actionis set toRedirectToLoginPage. Possible values include:apple,azureactivedirectory,facebook,github,google,twitterand thenameof yourcustom_oidc_v2provider.NOTE: Whilst any value will be accepted by the API for
default_provider, it can leave the app in an unusable state if this value does not correspond to the name of a known provider (either built-in value, or custom_oidc name) as it is used to build the auth endpoint URI.- excluded
Paths List<String> The paths which should be excluded from the
unauthenticated_actionwhen it is set toRedirectToLoginPage.NOTE: This list should be used instead of setting
WEBSITE_WARMUP_PATHinapp_settingsas it takes priority.- facebook
V2 Property Map - A
facebook_v2block as defined below. - forward
Proxy StringConvention - The convention used to determine the url of the request made. Possible values include
NoProxy,Standard,Custom. Defaults toNoProxy. - forward
Proxy StringCustom Host Header Name - The name of the custom header containing the host of the request.
- forward
Proxy StringCustom Scheme Header Name - The name of the custom header containing the scheme of the request.
- github
V2 Property Map - A
github_v2block as defined below. - google
V2 Property Map - A
google_v2block as defined below. - http
Route StringApi Prefix - The prefix that should precede all the authentication and authorisation paths. Defaults to
/.auth. - microsoft
V2 Property Map - A
microsoft_v2block as defined below. - require
Authentication Boolean - Should the authentication flow be used for all requests.
- require
Https Boolean - Should HTTPS be required on connections? Defaults to
true. - runtime
Version String - The Runtime Version of the Authentication and Authorisation feature of this App. Defaults to
~1. - twitter
V2 Property Map - A
twitter_v2block as defined below. - unauthenticated
Action String - The action to take for requests made without authentication. Possible values include
RedirectToLoginPage,AllowAnonymous,Return401, andReturn403. Defaults toRedirectToLoginPage.
WindowsWebAppAuthSettingsV2ActiveDirectoryV2, WindowsWebAppAuthSettingsV2ActiveDirectoryV2Args
- Client
Id string - The ID of the Client to use to authenticate with Azure Active Directory.
- Tenant
Auth stringEndpoint The Azure Tenant Endpoint for the Authenticating Tenant. e.g.
https://login.microsoftonline.com/{tenant-guid}/v2.0/NOTE: Here is a list of possible authentication endpoints based on the cloud environment. Here is more information to better understand how to configure authentication for Azure App Service or Azure Functions.
- Allowed
Applications List<string> - The list of allowed Applications for the Default Authorisation Policy.
- Allowed
Audiences List<string> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- Allowed
Groups List<string> - The list of allowed Group Names for the Default Authorisation Policy.
- Allowed
Identities List<string> - The list of allowed Identities for the Default Authorisation Policy.
- Client
Secret stringCertificate Thumbprint - The thumbprint of the certificate used for signing purposes.
- Client
Secret stringSetting Name The App Setting name that contains the client secret of the Client.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Jwt
Allowed List<string>Client Applications - A list of Allowed Client Applications in the JWT Claim.
- Jwt
Allowed List<string>Groups - A list of Allowed Groups in the JWT Claim.
- Login
Parameters Dictionary<string, string> - A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
- Www
Authentication boolDisabled - Should the www-authenticate provider should be omitted from the request? Defaults to
false.
- Client
Id string - The ID of the Client to use to authenticate with Azure Active Directory.
- Tenant
Auth stringEndpoint The Azure Tenant Endpoint for the Authenticating Tenant. e.g.
https://login.microsoftonline.com/{tenant-guid}/v2.0/NOTE: Here is a list of possible authentication endpoints based on the cloud environment. Here is more information to better understand how to configure authentication for Azure App Service or Azure Functions.
- Allowed
Applications []string - The list of allowed Applications for the Default Authorisation Policy.
- Allowed
Audiences []string Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- Allowed
Groups []string - The list of allowed Group Names for the Default Authorisation Policy.
- Allowed
Identities []string - The list of allowed Identities for the Default Authorisation Policy.
- Client
Secret stringCertificate Thumbprint - The thumbprint of the certificate used for signing purposes.
- Client
Secret stringSetting Name The App Setting name that contains the client secret of the Client.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Jwt
Allowed []stringClient Applications - A list of Allowed Client Applications in the JWT Claim.
- Jwt
Allowed []stringGroups - A list of Allowed Groups in the JWT Claim.
- Login
Parameters map[string]string - A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
- Www
Authentication boolDisabled - Should the www-authenticate provider should be omitted from the request? Defaults to
false.
- client
Id String - The ID of the Client to use to authenticate with Azure Active Directory.
- tenant
Auth StringEndpoint The Azure Tenant Endpoint for the Authenticating Tenant. e.g.
https://login.microsoftonline.com/{tenant-guid}/v2.0/NOTE: Here is a list of possible authentication endpoints based on the cloud environment. Here is more information to better understand how to configure authentication for Azure App Service or Azure Functions.
- allowed
Applications List<String> - The list of allowed Applications for the Default Authorisation Policy.
- allowed
Audiences List<String> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- allowed
Groups List<String> - The list of allowed Group Names for the Default Authorisation Policy.
- allowed
Identities List<String> - The list of allowed Identities for the Default Authorisation Policy.
- client
Secret StringCertificate Thumbprint - The thumbprint of the certificate used for signing purposes.
- client
Secret StringSetting Name The App Setting name that contains the client secret of the Client.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- jwt
Allowed List<String>Client Applications - A list of Allowed Client Applications in the JWT Claim.
- jwt
Allowed List<String>Groups - A list of Allowed Groups in the JWT Claim.
- login
Parameters Map<String,String> - A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
- www
Authentication BooleanDisabled - Should the www-authenticate provider should be omitted from the request? Defaults to
false.
- client
Id string - The ID of the Client to use to authenticate with Azure Active Directory.
- tenant
Auth stringEndpoint The Azure Tenant Endpoint for the Authenticating Tenant. e.g.
https://login.microsoftonline.com/{tenant-guid}/v2.0/NOTE: Here is a list of possible authentication endpoints based on the cloud environment. Here is more information to better understand how to configure authentication for Azure App Service or Azure Functions.
- allowed
Applications string[] - The list of allowed Applications for the Default Authorisation Policy.
- allowed
Audiences string[] Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- allowed
Groups string[] - The list of allowed Group Names for the Default Authorisation Policy.
- allowed
Identities string[] - The list of allowed Identities for the Default Authorisation Policy.
- client
Secret stringCertificate Thumbprint - The thumbprint of the certificate used for signing purposes.
- client
Secret stringSetting Name The App Setting name that contains the client secret of the Client.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- jwt
Allowed string[]Client Applications - A list of Allowed Client Applications in the JWT Claim.
- jwt
Allowed string[]Groups - A list of Allowed Groups in the JWT Claim.
- login
Parameters {[key: string]: string} - A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
- www
Authentication booleanDisabled - Should the www-authenticate provider should be omitted from the request? Defaults to
false.
- client_
id str - The ID of the Client to use to authenticate with Azure Active Directory.
- tenant_
auth_ strendpoint The Azure Tenant Endpoint for the Authenticating Tenant. e.g.
https://login.microsoftonline.com/{tenant-guid}/v2.0/NOTE: Here is a list of possible authentication endpoints based on the cloud environment. Here is more information to better understand how to configure authentication for Azure App Service or Azure Functions.
- allowed_
applications Sequence[str] - The list of allowed Applications for the Default Authorisation Policy.
- allowed_
audiences Sequence[str] Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- allowed_
groups Sequence[str] - The list of allowed Group Names for the Default Authorisation Policy.
- allowed_
identities Sequence[str] - The list of allowed Identities for the Default Authorisation Policy.
- client_
secret_ strcertificate_ thumbprint - The thumbprint of the certificate used for signing purposes.
- client_
secret_ strsetting_ name The App Setting name that contains the client secret of the Client.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- jwt_
allowed_ Sequence[str]client_ applications - A list of Allowed Client Applications in the JWT Claim.
- jwt_
allowed_ Sequence[str]groups - A list of Allowed Groups in the JWT Claim.
- login_
parameters Mapping[str, str] - A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
- www_
authentication_ booldisabled - Should the www-authenticate provider should be omitted from the request? Defaults to
false.
- client
Id String - The ID of the Client to use to authenticate with Azure Active Directory.
- tenant
Auth StringEndpoint The Azure Tenant Endpoint for the Authenticating Tenant. e.g.
https://login.microsoftonline.com/{tenant-guid}/v2.0/NOTE: Here is a list of possible authentication endpoints based on the cloud environment. Here is more information to better understand how to configure authentication for Azure App Service or Azure Functions.
- allowed
Applications List<String> - The list of allowed Applications for the Default Authorisation Policy.
- allowed
Audiences List<String> Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- allowed
Groups List<String> - The list of allowed Group Names for the Default Authorisation Policy.
- allowed
Identities List<String> - The list of allowed Identities for the Default Authorisation Policy.
- client
Secret StringCertificate Thumbprint - The thumbprint of the certificate used for signing purposes.
- client
Secret StringSetting Name The App Setting name that contains the client secret of the Client.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- jwt
Allowed List<String>Client Applications - A list of Allowed Client Applications in the JWT Claim.
- jwt
Allowed List<String>Groups - A list of Allowed Groups in the JWT Claim.
- login
Parameters Map<String> - A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
- www
Authentication BooleanDisabled - Should the www-authenticate provider should be omitted from the request? Defaults to
false.
WindowsWebAppAuthSettingsV2AppleV2, WindowsWebAppAuthSettingsV2AppleV2Args
- Client
Id string - The OpenID Connect Client ID for the Apple web application.
- Client
Secret stringSetting Name The app setting name that contains the
client_secretvalue used for Apple Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Login
Scopes List<string> A list of Login Scopes provided by this Authentication Provider.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- Client
Id string - The OpenID Connect Client ID for the Apple web application.
- Client
Secret stringSetting Name The app setting name that contains the
client_secretvalue used for Apple Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Login
Scopes []string A list of Login Scopes provided by this Authentication Provider.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- client
Id String - The OpenID Connect Client ID for the Apple web application.
- client
Secret StringSetting Name The app setting name that contains the
client_secretvalue used for Apple Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- login
Scopes List<String> A list of Login Scopes provided by this Authentication Provider.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- client
Id string - The OpenID Connect Client ID for the Apple web application.
- client
Secret stringSetting Name The app setting name that contains the
client_secretvalue used for Apple Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- login
Scopes string[] A list of Login Scopes provided by this Authentication Provider.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- client_
id str - The OpenID Connect Client ID for the Apple web application.
- client_
secret_ strsetting_ name The app setting name that contains the
client_secretvalue used for Apple Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- login_
scopes Sequence[str] A list of Login Scopes provided by this Authentication Provider.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
- client
Id String - The OpenID Connect Client ID for the Apple web application.
- client
Secret StringSetting Name The app setting name that contains the
client_secretvalue used for Apple Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- login
Scopes List<String> A list of Login Scopes provided by this Authentication Provider.
NOTE: This is configured on the Authentication Provider side and is Read Only here.
WindowsWebAppAuthSettingsV2AzureStaticWebAppV2, WindowsWebAppAuthSettingsV2AzureStaticWebAppV2Args
- Client
Id string - The ID of the Client to use to authenticate with Azure Static Web App Authentication.
- Client
Id string - The ID of the Client to use to authenticate with Azure Static Web App Authentication.
- client
Id String - The ID of the Client to use to authenticate with Azure Static Web App Authentication.
- client
Id string - The ID of the Client to use to authenticate with Azure Static Web App Authentication.
- client_
id str - The ID of the Client to use to authenticate with Azure Static Web App Authentication.
- client
Id String - The ID of the Client to use to authenticate with Azure Static Web App Authentication.
WindowsWebAppAuthSettingsV2CustomOidcV2, WindowsWebAppAuthSettingsV2CustomOidcV2Args
- Client
Id string - The ID of the Client to use to authenticate with the Custom OIDC.
- Name string
The name of the Custom OIDC Authentication Provider.
NOTE: An
app_settingmatching this value in upper case with the suffix of_PROVIDER_AUTHENTICATION_SECRETis required. e.g.MYOIDC_PROVIDER_AUTHENTICATION_SECRETfor a value ofmyoidc.- Openid
Configuration stringEndpoint - The app setting name that contains the
client_secretvalue used for the Custom OIDC Login. - string
- The endpoint to make the Authorisation Request as supplied by
openid_configuration_endpointresponse. - Certification
Uri string - The endpoint that provides the keys necessary to validate the token as supplied by
openid_configuration_endpointresponse. - Client
Credential stringMethod - The Client Credential Method used.
- Client
Secret stringSetting Name - The App Setting name that contains the secret for this Custom OIDC Client. This is generated from
nameabove and suffixed with_PROVIDER_AUTHENTICATION_SECRET. - Issuer
Endpoint string - The endpoint that issued the Token as supplied by
openid_configuration_endpointresponse. - Name
Claim stringType - The name of the claim that contains the users name.
- Scopes List<string>
- The list of the scopes that should be requested while authenticating.
- Token
Endpoint string - The endpoint used to request a Token as supplied by
openid_configuration_endpointresponse.
- Client
Id string - The ID of the Client to use to authenticate with the Custom OIDC.
- Name string
The name of the Custom OIDC Authentication Provider.
NOTE: An
app_settingmatching this value in upper case with the suffix of_PROVIDER_AUTHENTICATION_SECRETis required. e.g.MYOIDC_PROVIDER_AUTHENTICATION_SECRETfor a value ofmyoidc.- Openid
Configuration stringEndpoint - The app setting name that contains the
client_secretvalue used for the Custom OIDC Login. - string
- The endpoint to make the Authorisation Request as supplied by
openid_configuration_endpointresponse. - Certification
Uri string - The endpoint that provides the keys necessary to validate the token as supplied by
openid_configuration_endpointresponse. - Client
Credential stringMethod - The Client Credential Method used.
- Client
Secret stringSetting Name - The App Setting name that contains the secret for this Custom OIDC Client. This is generated from
nameabove and suffixed with_PROVIDER_AUTHENTICATION_SECRET. - Issuer
Endpoint string - The endpoint that issued the Token as supplied by
openid_configuration_endpointresponse. - Name
Claim stringType - The name of the claim that contains the users name.
- Scopes []string
- The list of the scopes that should be requested while authenticating.
- Token
Endpoint string - The endpoint used to request a Token as supplied by
openid_configuration_endpointresponse.
- client
Id String - The ID of the Client to use to authenticate with the Custom OIDC.
- name String
The name of the Custom OIDC Authentication Provider.
NOTE: An
app_settingmatching this value in upper case with the suffix of_PROVIDER_AUTHENTICATION_SECRETis required. e.g.MYOIDC_PROVIDER_AUTHENTICATION_SECRETfor a value ofmyoidc.- openid
Configuration StringEndpoint - The app setting name that contains the
client_secretvalue used for the Custom OIDC Login. - String
- The endpoint to make the Authorisation Request as supplied by
openid_configuration_endpointresponse. - certification
Uri String - The endpoint that provides the keys necessary to validate the token as supplied by
openid_configuration_endpointresponse. - client
Credential StringMethod - The Client Credential Method used.
- client
Secret StringSetting Name - The App Setting name that contains the secret for this Custom OIDC Client. This is generated from
nameabove and suffixed with_PROVIDER_AUTHENTICATION_SECRET. - issuer
Endpoint String - The endpoint that issued the Token as supplied by
openid_configuration_endpointresponse. - name
Claim StringType - The name of the claim that contains the users name.
- scopes List<String>
- The list of the scopes that should be requested while authenticating.
- token
Endpoint String - The endpoint used to request a Token as supplied by
openid_configuration_endpointresponse.
- client
Id string - The ID of the Client to use to authenticate with the Custom OIDC.
- name string
The name of the Custom OIDC Authentication Provider.
NOTE: An
app_settingmatching this value in upper case with the suffix of_PROVIDER_AUTHENTICATION_SECRETis required. e.g.MYOIDC_PROVIDER_AUTHENTICATION_SECRETfor a value ofmyoidc.- openid
Configuration stringEndpoint - The app setting name that contains the
client_secretvalue used for the Custom OIDC Login. - string
- The endpoint to make the Authorisation Request as supplied by
openid_configuration_endpointresponse. - certification
Uri string - The endpoint that provides the keys necessary to validate the token as supplied by
openid_configuration_endpointresponse. - client
Credential stringMethod - The Client Credential Method used.
- client
Secret stringSetting Name - The App Setting name that contains the secret for this Custom OIDC Client. This is generated from
nameabove and suffixed with_PROVIDER_AUTHENTICATION_SECRET. - issuer
Endpoint string - The endpoint that issued the Token as supplied by
openid_configuration_endpointresponse. - name
Claim stringType - The name of the claim that contains the users name.
- scopes string[]
- The list of the scopes that should be requested while authenticating.
- token
Endpoint string - The endpoint used to request a Token as supplied by
openid_configuration_endpointresponse.
- client_
id str - The ID of the Client to use to authenticate with the Custom OIDC.
- name str
The name of the Custom OIDC Authentication Provider.
NOTE: An
app_settingmatching this value in upper case with the suffix of_PROVIDER_AUTHENTICATION_SECRETis required. e.g.MYOIDC_PROVIDER_AUTHENTICATION_SECRETfor a value ofmyoidc.- openid_
configuration_ strendpoint - The app setting name that contains the
client_secretvalue used for the Custom OIDC Login. - str
- The endpoint to make the Authorisation Request as supplied by
openid_configuration_endpointresponse. - certification_
uri str - The endpoint that provides the keys necessary to validate the token as supplied by
openid_configuration_endpointresponse. - client_
credential_ strmethod - The Client Credential Method used.
- client_
secret_ strsetting_ name - The App Setting name that contains the secret for this Custom OIDC Client. This is generated from
nameabove and suffixed with_PROVIDER_AUTHENTICATION_SECRET. - issuer_
endpoint str - The endpoint that issued the Token as supplied by
openid_configuration_endpointresponse. - name_
claim_ strtype - The name of the claim that contains the users name.
- scopes Sequence[str]
- The list of the scopes that should be requested while authenticating.
- token_
endpoint str - The endpoint used to request a Token as supplied by
openid_configuration_endpointresponse.
- client
Id String - The ID of the Client to use to authenticate with the Custom OIDC.
- name String
The name of the Custom OIDC Authentication Provider.
NOTE: An
app_settingmatching this value in upper case with the suffix of_PROVIDER_AUTHENTICATION_SECRETis required. e.g.MYOIDC_PROVIDER_AUTHENTICATION_SECRETfor a value ofmyoidc.- openid
Configuration StringEndpoint - The app setting name that contains the
client_secretvalue used for the Custom OIDC Login. - String
- The endpoint to make the Authorisation Request as supplied by
openid_configuration_endpointresponse. - certification
Uri String - The endpoint that provides the keys necessary to validate the token as supplied by
openid_configuration_endpointresponse. - client
Credential StringMethod - The Client Credential Method used.
- client
Secret StringSetting Name - The App Setting name that contains the secret for this Custom OIDC Client. This is generated from
nameabove and suffixed with_PROVIDER_AUTHENTICATION_SECRET. - issuer
Endpoint String - The endpoint that issued the Token as supplied by
openid_configuration_endpointresponse. - name
Claim StringType - The name of the claim that contains the users name.
- scopes List<String>
- The list of the scopes that should be requested while authenticating.
- token
Endpoint String - The endpoint used to request a Token as supplied by
openid_configuration_endpointresponse.
WindowsWebAppAuthSettingsV2FacebookV2, WindowsWebAppAuthSettingsV2FacebookV2Args
- App
Id string - The App ID of the Facebook app used for login.
- App
Secret stringSetting Name The app setting name that contains the
app_secretvalue used for Facebook Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Graph
Api stringVersion - The version of the Facebook API to be used while logging in.
- Login
Scopes List<string> - The list of scopes that should be requested as part of Facebook Login authentication.
- App
Id string - The App ID of the Facebook app used for login.
- App
Secret stringSetting Name The app setting name that contains the
app_secretvalue used for Facebook Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Graph
Api stringVersion - The version of the Facebook API to be used while logging in.
- Login
Scopes []string - The list of scopes that should be requested as part of Facebook Login authentication.
- app
Id String - The App ID of the Facebook app used for login.
- app
Secret StringSetting Name The app setting name that contains the
app_secretvalue used for Facebook Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- graph
Api StringVersion - The version of the Facebook API to be used while logging in.
- login
Scopes List<String> - The list of scopes that should be requested as part of Facebook Login authentication.
- app
Id string - The App ID of the Facebook app used for login.
- app
Secret stringSetting Name The app setting name that contains the
app_secretvalue used for Facebook Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- graph
Api stringVersion - The version of the Facebook API to be used while logging in.
- login
Scopes string[] - The list of scopes that should be requested as part of Facebook Login authentication.
- app_
id str - The App ID of the Facebook app used for login.
- app_
secret_ strsetting_ name The app setting name that contains the
app_secretvalue used for Facebook Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- graph_
api_ strversion - The version of the Facebook API to be used while logging in.
- login_
scopes Sequence[str] - The list of scopes that should be requested as part of Facebook Login authentication.
- app
Id String - The App ID of the Facebook app used for login.
- app
Secret StringSetting Name The app setting name that contains the
app_secretvalue used for Facebook Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- graph
Api StringVersion - The version of the Facebook API to be used while logging in.
- login
Scopes List<String> - The list of scopes that should be requested as part of Facebook Login authentication.
WindowsWebAppAuthSettingsV2GithubV2, WindowsWebAppAuthSettingsV2GithubV2Args
- Client
Id string - The ID of the GitHub app used for login.
- Client
Secret stringSetting Name The app setting name that contains the
client_secretvalue used for GitHub Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Login
Scopes List<string> - The list of OAuth 2.0 scopes that should be requested as part of GitHub Login authentication.
- Client
Id string - The ID of the GitHub app used for login.
- Client
Secret stringSetting Name The app setting name that contains the
client_secretvalue used for GitHub Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Login
Scopes []string - The list of OAuth 2.0 scopes that should be requested as part of GitHub Login authentication.
- client
Id String - The ID of the GitHub app used for login.
- client
Secret StringSetting Name The app setting name that contains the
client_secretvalue used for GitHub Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- login
Scopes List<String> - The list of OAuth 2.0 scopes that should be requested as part of GitHub Login authentication.
- client
Id string - The ID of the GitHub app used for login.
- client
Secret stringSetting Name The app setting name that contains the
client_secretvalue used for GitHub Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- login
Scopes string[] - The list of OAuth 2.0 scopes that should be requested as part of GitHub Login authentication.
- client_
id str - The ID of the GitHub app used for login.
- client_
secret_ strsetting_ name The app setting name that contains the
client_secretvalue used for GitHub Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- login_
scopes Sequence[str] - The list of OAuth 2.0 scopes that should be requested as part of GitHub Login authentication.
- client
Id String - The ID of the GitHub app used for login.
- client
Secret StringSetting Name The app setting name that contains the
client_secretvalue used for GitHub Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- login
Scopes List<String> - The list of OAuth 2.0 scopes that should be requested as part of GitHub Login authentication.
WindowsWebAppAuthSettingsV2GoogleV2, WindowsWebAppAuthSettingsV2GoogleV2Args
- Client
Id string - The OpenID Connect Client ID for the Google web application.
- Client
Secret stringSetting Name The app setting name that contains the
client_secretvalue used for Google Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Allowed
Audiences List<string> - Specifies a list of Allowed Audiences that should be requested as part of Google Sign-In authentication.
- Login
Scopes List<string> - The list of OAuth 2.0 scopes that should be requested as part of Google Sign-In authentication.
- Client
Id string - The OpenID Connect Client ID for the Google web application.
- Client
Secret stringSetting Name The app setting name that contains the
client_secretvalue used for Google Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Allowed
Audiences []string - Specifies a list of Allowed Audiences that should be requested as part of Google Sign-In authentication.
- Login
Scopes []string - The list of OAuth 2.0 scopes that should be requested as part of Google Sign-In authentication.
- client
Id String - The OpenID Connect Client ID for the Google web application.
- client
Secret StringSetting Name The app setting name that contains the
client_secretvalue used for Google Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- allowed
Audiences List<String> - Specifies a list of Allowed Audiences that should be requested as part of Google Sign-In authentication.
- login
Scopes List<String> - The list of OAuth 2.0 scopes that should be requested as part of Google Sign-In authentication.
- client
Id string - The OpenID Connect Client ID for the Google web application.
- client
Secret stringSetting Name The app setting name that contains the
client_secretvalue used for Google Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- allowed
Audiences string[] - Specifies a list of Allowed Audiences that should be requested as part of Google Sign-In authentication.
- login
Scopes string[] - The list of OAuth 2.0 scopes that should be requested as part of Google Sign-In authentication.
- client_
id str - The OpenID Connect Client ID for the Google web application.
- client_
secret_ strsetting_ name The app setting name that contains the
client_secretvalue used for Google Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- allowed_
audiences Sequence[str] - Specifies a list of Allowed Audiences that should be requested as part of Google Sign-In authentication.
- login_
scopes Sequence[str] - The list of OAuth 2.0 scopes that should be requested as part of Google Sign-In authentication.
- client
Id String - The OpenID Connect Client ID for the Google web application.
- client
Secret StringSetting Name The app setting name that contains the
client_secretvalue used for Google Login.!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- allowed
Audiences List<String> - Specifies a list of Allowed Audiences that should be requested as part of Google Sign-In authentication.
- login
Scopes List<String> - The list of OAuth 2.0 scopes that should be requested as part of Google Sign-In authentication.
WindowsWebAppAuthSettingsV2Login, WindowsWebAppAuthSettingsV2LoginArgs
- Allowed
External List<string>Redirect Urls External URLs that can be redirected to as part of logging in or logging out of the app. This is an advanced setting typically only needed by Windows Store application backends.
Note: URLs within the current domain are always implicitly allowed.
- string
- The method by which cookies expire. Possible values include:
FixedTime, andIdentityProviderDerived. Defaults toFixedTime. - string
- The time after the request is made when the session cookie should expire. Defaults to
08:00:00. - Logout
Endpoint string - The endpoint to which logout requests should be made.
- Nonce
Expiration stringTime - The time after the request is made when the nonce should expire. Defaults to
00:05:00. - Preserve
Url boolFragments For Logins - Should the fragments from the request be preserved after the login request is made. Defaults to
false. - Token
Refresh doubleExtension Time - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - Token
Store boolEnabled - Should the Token Store configuration Enabled. Defaults to
false - Token
Store stringPath - The directory path in the App Filesystem in which the tokens will be stored.
- Token
Store stringSas Setting Name - The name of the app setting which contains the SAS URL of the blob storage containing the tokens.
- Validate
Nonce bool - Should the nonce be validated while completing the login flow. Defaults to
true.
- Allowed
External []stringRedirect Urls External URLs that can be redirected to as part of logging in or logging out of the app. This is an advanced setting typically only needed by Windows Store application backends.
Note: URLs within the current domain are always implicitly allowed.
- string
- The method by which cookies expire. Possible values include:
FixedTime, andIdentityProviderDerived. Defaults toFixedTime. - string
- The time after the request is made when the session cookie should expire. Defaults to
08:00:00. - Logout
Endpoint string - The endpoint to which logout requests should be made.
- Nonce
Expiration stringTime - The time after the request is made when the nonce should expire. Defaults to
00:05:00. - Preserve
Url boolFragments For Logins - Should the fragments from the request be preserved after the login request is made. Defaults to
false. - Token
Refresh float64Extension Time - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - Token
Store boolEnabled - Should the Token Store configuration Enabled. Defaults to
false - Token
Store stringPath - The directory path in the App Filesystem in which the tokens will be stored.
- Token
Store stringSas Setting Name - The name of the app setting which contains the SAS URL of the blob storage containing the tokens.
- Validate
Nonce bool - Should the nonce be validated while completing the login flow. Defaults to
true.
- allowed
External List<String>Redirect Urls External URLs that can be redirected to as part of logging in or logging out of the app. This is an advanced setting typically only needed by Windows Store application backends.
Note: URLs within the current domain are always implicitly allowed.
- String
- The method by which cookies expire. Possible values include:
FixedTime, andIdentityProviderDerived. Defaults toFixedTime. - String
- The time after the request is made when the session cookie should expire. Defaults to
08:00:00. - logout
Endpoint String - The endpoint to which logout requests should be made.
- nonce
Expiration StringTime - The time after the request is made when the nonce should expire. Defaults to
00:05:00. - preserve
Url BooleanFragments For Logins - Should the fragments from the request be preserved after the login request is made. Defaults to
false. - token
Refresh DoubleExtension Time - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - token
Store BooleanEnabled - Should the Token Store configuration Enabled. Defaults to
false - token
Store StringPath - The directory path in the App Filesystem in which the tokens will be stored.
- token
Store StringSas Setting Name - The name of the app setting which contains the SAS URL of the blob storage containing the tokens.
- validate
Nonce Boolean - Should the nonce be validated while completing the login flow. Defaults to
true.
- allowed
External string[]Redirect Urls External URLs that can be redirected to as part of logging in or logging out of the app. This is an advanced setting typically only needed by Windows Store application backends.
Note: URLs within the current domain are always implicitly allowed.
- string
- The method by which cookies expire. Possible values include:
FixedTime, andIdentityProviderDerived. Defaults toFixedTime. - string
- The time after the request is made when the session cookie should expire. Defaults to
08:00:00. - logout
Endpoint string - The endpoint to which logout requests should be made.
- nonce
Expiration stringTime - The time after the request is made when the nonce should expire. Defaults to
00:05:00. - preserve
Url booleanFragments For Logins - Should the fragments from the request be preserved after the login request is made. Defaults to
false. - token
Refresh numberExtension Time - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - token
Store booleanEnabled - Should the Token Store configuration Enabled. Defaults to
false - token
Store stringPath - The directory path in the App Filesystem in which the tokens will be stored.
- token
Store stringSas Setting Name - The name of the app setting which contains the SAS URL of the blob storage containing the tokens.
- validate
Nonce boolean - Should the nonce be validated while completing the login flow. Defaults to
true.
- allowed_
external_ Sequence[str]redirect_ urls External URLs that can be redirected to as part of logging in or logging out of the app. This is an advanced setting typically only needed by Windows Store application backends.
Note: URLs within the current domain are always implicitly allowed.
- str
- The method by which cookies expire. Possible values include:
FixedTime, andIdentityProviderDerived. Defaults toFixedTime. - str
- The time after the request is made when the session cookie should expire. Defaults to
08:00:00. - logout_
endpoint str - The endpoint to which logout requests should be made.
- nonce_
expiration_ strtime - The time after the request is made when the nonce should expire. Defaults to
00:05:00. - preserve_
url_ boolfragments_ for_ logins - Should the fragments from the request be preserved after the login request is made. Defaults to
false. - token_
refresh_ floatextension_ time - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - token_
store_ boolenabled - Should the Token Store configuration Enabled. Defaults to
false - token_
store_ strpath - The directory path in the App Filesystem in which the tokens will be stored.
- token_
store_ strsas_ setting_ name - The name of the app setting which contains the SAS URL of the blob storage containing the tokens.
- validate_
nonce bool - Should the nonce be validated while completing the login flow. Defaults to
true.
- allowed
External List<String>Redirect Urls External URLs that can be redirected to as part of logging in or logging out of the app. This is an advanced setting typically only needed by Windows Store application backends.
Note: URLs within the current domain are always implicitly allowed.
- String
- The method by which cookies expire. Possible values include:
FixedTime, andIdentityProviderDerived. Defaults toFixedTime. - String
- The time after the request is made when the session cookie should expire. Defaults to
08:00:00. - logout
Endpoint String - The endpoint to which logout requests should be made.
- nonce
Expiration StringTime - The time after the request is made when the nonce should expire. Defaults to
00:05:00. - preserve
Url BooleanFragments For Logins - Should the fragments from the request be preserved after the login request is made. Defaults to
false. - token
Refresh NumberExtension Time - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72hours. - token
Store BooleanEnabled - Should the Token Store configuration Enabled. Defaults to
false - token
Store StringPath - The directory path in the App Filesystem in which the tokens will be stored.
- token
Store StringSas Setting Name - The name of the app setting which contains the SAS URL of the blob storage containing the tokens.
- validate
Nonce Boolean - Should the nonce be validated while completing the login flow. Defaults to
true.
WindowsWebAppAuthSettingsV2MicrosoftV2, WindowsWebAppAuthSettingsV2MicrosoftV2Args
- Client
Id string - The OAuth 2.0 client ID that was created for the app used for authentication.
- Client
Secret stringSetting Name The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Allowed
Audiences List<string> - Specifies a list of Allowed Audiences that will be requested as part of Microsoft Sign-In authentication.
- Login
Scopes List<string> - The list of Login scopes that should be requested as part of Microsoft Account authentication.
- Client
Id string - The OAuth 2.0 client ID that was created for the app used for authentication.
- Client
Secret stringSetting Name The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- Allowed
Audiences []string - Specifies a list of Allowed Audiences that will be requested as part of Microsoft Sign-In authentication.
- Login
Scopes []string - The list of Login scopes that should be requested as part of Microsoft Account authentication.
- client
Id String - The OAuth 2.0 client ID that was created for the app used for authentication.
- client
Secret StringSetting Name The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- allowed
Audiences List<String> - Specifies a list of Allowed Audiences that will be requested as part of Microsoft Sign-In authentication.
- login
Scopes List<String> - The list of Login scopes that should be requested as part of Microsoft Account authentication.
- client
Id string - The OAuth 2.0 client ID that was created for the app used for authentication.
- client
Secret stringSetting Name The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- allowed
Audiences string[] - Specifies a list of Allowed Audiences that will be requested as part of Microsoft Sign-In authentication.
- login
Scopes string[] - The list of Login scopes that should be requested as part of Microsoft Account authentication.
- client_
id str - The OAuth 2.0 client ID that was created for the app used for authentication.
- client_
secret_ strsetting_ name The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- allowed_
audiences Sequence[str] - Specifies a list of Allowed Audiences that will be requested as part of Microsoft Sign-In authentication.
- login_
scopes Sequence[str] - The list of Login scopes that should be requested as part of Microsoft Account authentication.
- client
Id String - The OAuth 2.0 client ID that was created for the app used for authentication.
- client
Secret StringSetting Name The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.- allowed
Audiences List<String> - Specifies a list of Allowed Audiences that will be requested as part of Microsoft Sign-In authentication.
- login
Scopes List<String> - The list of Login scopes that should be requested as part of Microsoft Account authentication.
WindowsWebAppAuthSettingsV2TwitterV2, WindowsWebAppAuthSettingsV2TwitterV2Args
- Consumer
Key string - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- Consumer
Secret stringSetting Name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.
- Consumer
Key string - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- Consumer
Secret stringSetting Name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.
- consumer
Key String - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer
Secret StringSetting Name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.
- consumer
Key string - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer
Secret stringSetting Name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.
- consumer_
key str - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer_
secret_ strsetting_ name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.
- consumer
Key String - The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- consumer
Secret StringSetting Name The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
!> NOTE: A setting with this name must exist in
app_settingsto function correctly.
WindowsWebAppBackup, WindowsWebAppBackupArgs
- Name string
- The name which should be used for this Backup.
- Schedule
Windows
Web App Backup Schedule - A
scheduleblock as defined below. - Storage
Account stringUrl - The SAS URL to the container.
- Enabled bool
- Should this backup job be enabled? Defaults to
true.
- Name string
- The name which should be used for this Backup.
- Schedule
Windows
Web App Backup Schedule - A
scheduleblock as defined below. - Storage
Account stringUrl - The SAS URL to the container.
- Enabled bool
- Should this backup job be enabled? Defaults to
true.
- name String
- The name which should be used for this Backup.
- schedule
Windows
Web App Backup Schedule - A
scheduleblock as defined below. - storage
Account StringUrl - The SAS URL to the container.
- enabled Boolean
- Should this backup job be enabled? Defaults to
true.
- name string
- The name which should be used for this Backup.
- schedule
Windows
Web App Backup Schedule - A
scheduleblock as defined below. - storage
Account stringUrl - The SAS URL to the container.
- enabled boolean
- Should this backup job be enabled? Defaults to
true.
- name str
- The name which should be used for this Backup.
- schedule
Windows
Web App Backup Schedule - A
scheduleblock as defined below. - storage_
account_ strurl - The SAS URL to the container.
- enabled bool
- Should this backup job be enabled? Defaults to
true.
- name String
- The name which should be used for this Backup.
- schedule Property Map
- A
scheduleblock as defined below. - storage
Account StringUrl - The SAS URL to the container.
- enabled Boolean
- Should this backup job be enabled? Defaults to
true.
WindowsWebAppBackupSchedule, WindowsWebAppBackupScheduleArgs
- Frequency
Interval int How often the backup should be executed (e.g. for weekly backup, this should be set to
7andfrequency_unitshould be set toDay).NOTE: Not all intervals are supported on all Windows Web App SKUs. Please refer to the official documentation for appropriate values.
- Frequency
Unit string - The unit of time for how often the backup should take place. Possible values include:
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 - The time the backup was last attempted.
- Retention
Period intDays - After how many days backups should be deleted. Defaults to
30. - Start
Time string - When the schedule should start working in RFC-3339 format.
- Frequency
Interval int How often the backup should be executed (e.g. for weekly backup, this should be set to
7andfrequency_unitshould be set toDay).NOTE: Not all intervals are supported on all Windows Web App SKUs. Please refer to the official documentation for appropriate values.
- Frequency
Unit string - The unit of time for how often the backup should take place. Possible values include:
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 - The time the backup was last attempted.
- Retention
Period intDays - After how many days backups should be deleted. Defaults to
30. - Start
Time string - When the schedule should start working in RFC-3339 format.
- frequency
Interval Integer How often the backup should be executed (e.g. for weekly backup, this should be set to
7andfrequency_unitshould be set toDay).NOTE: Not all intervals are supported on all Windows Web App SKUs. Please refer to the official documentation for appropriate values.
- frequency
Unit String - The unit of time for how often the backup should take place. Possible values include:
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 - The time the backup was last attempted.
- retention
Period IntegerDays - After how many days backups should be deleted. Defaults to
30. - start
Time String - When the schedule should start working in RFC-3339 format.
- frequency
Interval number How often the backup should be executed (e.g. for weekly backup, this should be set to
7andfrequency_unitshould be set toDay).NOTE: Not all intervals are supported on all Windows Web App SKUs. Please refer to the official documentation for appropriate values.
- frequency
Unit string - The unit of time for how often the backup should take place. Possible values include:
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 - The time the backup was last attempted.
- retention
Period numberDays - After how many days backups should be deleted. Defaults to
30. - start
Time string - When the schedule should start working in RFC-3339 format.
- frequency_
interval int How often the backup should be executed (e.g. for weekly backup, this should be set to
7andfrequency_unitshould be set toDay).NOTE: Not all intervals are supported on all Windows Web App SKUs. Please refer to the official documentation for appropriate values.
- frequency_
unit str - The unit of time for how often the backup should take place. Possible values include:
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 - The time the backup was last attempted.
- retention_
period_ intdays - After how many days backups should be deleted. Defaults to
30. - start_
time str - When the schedule should start working in RFC-3339 format.
- frequency
Interval Number How often the backup should be executed (e.g. for weekly backup, this should be set to
7andfrequency_unitshould be set toDay).NOTE: Not all intervals are supported on all Windows Web App SKUs. Please refer to the official documentation for appropriate values.
- frequency
Unit String - The unit of time for how often the backup should take place. Possible values include:
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 - The time the backup was last attempted.
- retention
Period NumberDays - After how many days backups should be deleted. Defaults to
30. - start
Time String - When the schedule should start working in RFC-3339 format.
WindowsWebAppConnectionString, WindowsWebAppConnectionStringArgs
WindowsWebAppIdentity, WindowsWebAppIdentityArgs
- 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.
NOTE: This is required when
typeis set toUserAssignedorSystemAssigned, UserAssigned.- Principal
Id string - The Principal ID associated with this Managed Service Identity.
- Tenant
Id string - The Tenant ID associated with this Managed Service Identity.
- Type string
- Specifies the type of Managed Service Identity that should be configured on this Windows 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.
NOTE: This is required when
typeis set toUserAssignedorSystemAssigned, UserAssigned.- Principal
Id string - The Principal ID associated with this Managed Service Identity.
- Tenant
Id string - The Tenant ID associated with this Managed Service Identity.
- type String
- Specifies the type of Managed Service Identity that should be configured on this Windows 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.
NOTE: This is required when
typeis set toUserAssignedorSystemAssigned, UserAssigned.- principal
Id String - The Principal ID associated with this Managed Service Identity.
- tenant
Id String - The Tenant ID associated with this Managed Service Identity.
- type string
- Specifies the type of Managed Service Identity that should be configured on this Windows 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.
NOTE: This is required when
typeis set toUserAssignedorSystemAssigned, UserAssigned.- principal
Id string - The Principal ID associated with this Managed Service Identity.
- tenant
Id string - The Tenant ID associated with this Managed Service Identity.
- type str
- Specifies the type of Managed Service Identity that should be configured on this Windows 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.
NOTE: This is required when
typeis set toUserAssignedorSystemAssigned, UserAssigned.- principal_
id str - The Principal ID associated with this Managed Service Identity.
- tenant_
id str - The Tenant ID associated with this Managed Service Identity.
- type String
- Specifies the type of Managed Service Identity that should be configured on this Windows 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.
NOTE: This is required when
typeis set toUserAssignedorSystemAssigned, UserAssigned.- principal
Id String - The Principal ID associated with this Managed Service Identity.
- tenant
Id String - The Tenant ID associated with this Managed Service Identity.
WindowsWebAppLogs, WindowsWebAppLogsArgs
- Application
Logs WindowsWeb App Logs Application Logs - A
application_logsblock 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_logsblock as defined above.
- Application
Logs WindowsWeb App Logs Application Logs - A
application_logsblock 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_logsblock as defined above.
- application
Logs WindowsWeb App Logs Application Logs - A
application_logsblock 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_logsblock as defined above.
- application
Logs WindowsWeb App Logs Application Logs - A
application_logsblock 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_logsblock as defined above.
- application_
logs WindowsWeb App Logs Application Logs - A
application_logsblock 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_logsblock as defined above.
- application
Logs Property Map - A
application_logsblock 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_logsblock as defined above.
WindowsWebAppLogsApplicationLogs, WindowsWebAppLogsApplicationLogsArgs
- File
System stringLevel - Log level. Possible values include:
Off,Verbose,Information,Warning, andError. - Azure
Blob WindowsStorage Web App Logs Application Logs Azure Blob Storage - An
azure_blob_storageblock as defined below.
- File
System stringLevel - Log level. Possible values include:
Off,Verbose,Information,Warning, andError. - Azure
Blob WindowsStorage Web App Logs Application Logs Azure Blob Storage - An
azure_blob_storageblock as defined below.
- file
System StringLevel - Log level. Possible values include:
Off,Verbose,Information,Warning, andError. - azure
Blob WindowsStorage Web App Logs Application Logs Azure Blob Storage - An
azure_blob_storageblock as defined below.
- file
System stringLevel - Log level. Possible values include:
Off,Verbose,Information,Warning, andError. - azure
Blob WindowsStorage Web App Logs Application Logs Azure Blob Storage - An
azure_blob_storageblock as defined below.
- file_
system_ strlevel - Log level. Possible values include:
Off,Verbose,Information,Warning, andError. - azure_
blob_ Windowsstorage Web App Logs Application Logs Azure Blob Storage - An
azure_blob_storageblock as defined below.
- file
System StringLevel - Log level. Possible values include:
Off,Verbose,Information,Warning, andError. - azure
Blob Property MapStorage - An
azure_blob_storageblock as defined below.
WindowsWebAppLogsApplicationLogsAzureBlobStorage, WindowsWebAppLogsApplicationLogsAzureBlobStorageArgs
- Level string
- The level at which to log. Possible values include
Error,Warning,Information,VerboseandOff. NOTE: this field is not available forhttp_logs - Retention
In intDays - The time in days after which to remove blobs. A value of
0means 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,VerboseandOff. NOTE: this field is not available forhttp_logs - Retention
In intDays - The time in days after which to remove blobs. A value of
0means 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,VerboseandOff. NOTE: this field is not available forhttp_logs - retention
In IntegerDays - The time in days after which to remove blobs. A value of
0means 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,VerboseandOff. NOTE: this field is not available forhttp_logs - retention
In numberDays - The time in days after which to remove blobs. A value of
0means 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,VerboseandOff. NOTE: this field is not available forhttp_logs - retention_
in_ intdays - The time in days after which to remove blobs. A value of
0means 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,VerboseandOff. NOTE: this field is not available forhttp_logs - retention
In NumberDays - The time in days after which to remove blobs. A value of
0means no retention. - sas
Url String - SAS url to an Azure blob container with read/write/list/delete permissions.
WindowsWebAppLogsHttpLogs, WindowsWebAppLogsHttpLogsArgs
- Azure
Blob WindowsStorage Web App Logs Http Logs Azure Blob Storage - A
azure_blob_storage_httpblock as defined below. - File
System WindowsWeb App Logs Http Logs File System - A
file_systemblock as defined above.
- Azure
Blob WindowsStorage Web App Logs Http Logs Azure Blob Storage - A
azure_blob_storage_httpblock as defined below. - File
System WindowsWeb App Logs Http Logs File System - A
file_systemblock as defined above.
- azure
Blob WindowsStorage Web App Logs Http Logs Azure Blob Storage - A
azure_blob_storage_httpblock as defined below. - file
System WindowsWeb App Logs Http Logs File System - A
file_systemblock as defined above.
- azure
Blob WindowsStorage Web App Logs Http Logs Azure Blob Storage - A
azure_blob_storage_httpblock as defined below. - file
System WindowsWeb App Logs Http Logs File System - A
file_systemblock as defined above.
- azure_
blob_ Windowsstorage Web App Logs Http Logs Azure Blob Storage - A
azure_blob_storage_httpblock as defined below. - file_
system WindowsWeb App Logs Http Logs File System - A
file_systemblock as defined above.
- azure
Blob Property MapStorage - A
azure_blob_storage_httpblock as defined below. - file
System Property Map - A
file_systemblock as defined above.
WindowsWebAppLogsHttpLogsAzureBlobStorage, WindowsWebAppLogsHttpLogsAzureBlobStorageArgs
- 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
0means 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
0means 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
0means 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
0means 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
0means 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
0means no retention.
WindowsWebAppLogsHttpLogsFileSystem, WindowsWebAppLogsHttpLogsFileSystemArgs
- Retention
In intDays - The retention period in days. A values of
0means 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
0means 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
0means 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
0means 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
0means 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
0means no retention. - retention
In NumberMb - The maximum size in megabytes that log files can use.
WindowsWebAppSiteConfig, WindowsWebAppSiteConfigArgs
- Always
On bool If this Windows Web App is Always On enabled. Defaults to
true.NOTE:
always_onmust be explicitly set tofalsewhen usingFree,F1,D1, orSharedService Plans.- 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_stackblock as defined above. - Auto
Heal WindowsSetting Web App Site Config Auto Heal Setting - A
auto_heal_settingblock 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
corsblock 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 - Handler
Mappings List<WindowsWeb App Site Config Handler Mapping> - One or more
handler_mappingblocks as defined below. - Health
Check intEviction Time In Min - The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between
2and10. Only valid in conjunction withhealth_check_path. - Health
Check stringPath - The path to the Health Check.
- Http2Enabled bool
- Should the HTTP2 be enabled?
- Ip
Restriction stringDefault Action - The Default action for traffic that does not match any
ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - Ip
Restrictions List<WindowsWeb App Site Config Ip Restriction> - One or more
ip_restrictionblocks as defined above. - Linux
Fx stringVersion - Load
Balancing stringMode - The Site load balancing. Possible values include:
WeightedRoundRobin,LeastRequests,LeastResponseTime,WeightedTotalTraffic,RequestHash,PerSiteRoundRobin. Defaults toLeastRequestsif omitted. - Local
Mysql boolEnabled - Use Local MySQL. Defaults to
false. - Managed
Pipeline stringMode - Managed pipeline mode. Possible values include:
Integrated,Classic. Defaults toIntegrated. - Minimum
Tls stringVersion - The configures the minimum version of TLS required for SSL requests. Possible values include:
1.0,1.1,1.2and1.3. Defaults to1.2. - Remote
Debugging boolEnabled - Should Remote Debugging be enabled. Defaults to
false. - Remote
Debugging stringVersion - The Remote Debugging Version. Currently only
VS2022is supported. - Scm
Ip stringRestriction Default Action - The Default action for traffic that does not match any
scm_ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - Scm
Ip List<WindowsRestrictions Web App Site Config Scm Ip Restriction> - One or more
scm_ip_restrictionblocks 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_restrictionconfiguration 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_applicationblocks 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.NOTE:
always_onmust be explicitly set tofalsewhen usingFree,F1,D1, orSharedService Plans.- 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_stackblock as defined above. - Auto
Heal WindowsSetting Web App Site Config Auto Heal Setting - A
auto_heal_settingblock 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
corsblock as defined above. - Default
Documents []string - Specifies a list of Default Documents for the Windows Web App.
- Detailed
Error boolLogging Enabled - Ftps
State string - Handler
Mappings []WindowsWeb App Site Config Handler Mapping - One or more
handler_mappingblocks as defined below. - Health
Check intEviction Time In Min - The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between
2and10. Only valid in conjunction withhealth_check_path. - Health
Check stringPath - The path to the Health Check.
- Http2Enabled bool
- Should the HTTP2 be enabled?
- Ip
Restriction stringDefault Action - The Default action for traffic that does not match any
ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - Ip
Restrictions []WindowsWeb App Site Config Ip Restriction - One or more
ip_restrictionblocks as defined above. - Linux
Fx stringVersion - Load
Balancing stringMode - The Site load balancing. Possible values include:
WeightedRoundRobin,LeastRequests,LeastResponseTime,WeightedTotalTraffic,RequestHash,PerSiteRoundRobin. Defaults toLeastRequestsif omitted. - Local
Mysql boolEnabled - Use Local MySQL. Defaults to
false. - Managed
Pipeline stringMode - Managed pipeline mode. Possible values include:
Integrated,Classic. Defaults toIntegrated. - Minimum
Tls stringVersion - The configures the minimum version of TLS required for SSL requests. Possible values include:
1.0,1.1,1.2and1.3. Defaults to1.2. - Remote
Debugging boolEnabled - Should Remote Debugging be enabled. Defaults to
false. - Remote
Debugging stringVersion - The Remote Debugging Version. Currently only
VS2022is supported. - Scm
Ip stringRestriction Default Action - The Default action for traffic that does not match any
scm_ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - Scm
Ip []WindowsRestrictions Web App Site Config Scm Ip Restriction - One or more
scm_ip_restrictionblocks 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_restrictionconfiguration 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_applicationblocks 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.NOTE:
always_onmust be explicitly set tofalsewhen usingFree,F1,D1, orSharedService Plans.- 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_stackblock as defined above. - auto
Heal WindowsSetting Web App Site Config Auto Heal Setting - A
auto_heal_settingblock 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
corsblock 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 - handler
Mappings List<WindowsWeb App Site Config Handler Mapping> - One or more
handler_mappingblocks as defined below. - health
Check IntegerEviction Time In Min - The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between
2and10. Only valid in conjunction withhealth_check_path. - health
Check StringPath - The path to the Health Check.
- http2Enabled Boolean
- Should the HTTP2 be enabled?
- ip
Restriction StringDefault Action - The Default action for traffic that does not match any
ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - ip
Restrictions List<WindowsWeb App Site Config Ip Restriction> - One or more
ip_restrictionblocks as defined above. - linux
Fx StringVersion - load
Balancing StringMode - The Site load balancing. Possible values include:
WeightedRoundRobin,LeastRequests,LeastResponseTime,WeightedTotalTraffic,RequestHash,PerSiteRoundRobin. Defaults toLeastRequestsif omitted. - local
Mysql BooleanEnabled - Use Local MySQL. Defaults to
false. - managed
Pipeline StringMode - Managed pipeline mode. Possible values include:
Integrated,Classic. Defaults toIntegrated. - minimum
Tls StringVersion - The configures the minimum version of TLS required for SSL requests. Possible values include:
1.0,1.1,1.2and1.3. Defaults to1.2. - remote
Debugging BooleanEnabled - Should Remote Debugging be enabled. Defaults to
false. - remote
Debugging StringVersion - The Remote Debugging Version. Currently only
VS2022is supported. - scm
Ip StringRestriction Default Action - The Default action for traffic that does not match any
scm_ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - scm
Ip List<WindowsRestrictions Web App Site Config Scm Ip Restriction> - One or more
scm_ip_restrictionblocks 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_restrictionconfiguration 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_applicationblocks 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.NOTE:
always_onmust be explicitly set tofalsewhen usingFree,F1,D1, orSharedService Plans.- 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_stackblock as defined above. - auto
Heal WindowsSetting Web App Site Config Auto Heal Setting - A
auto_heal_settingblock 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
corsblock as defined above. - default
Documents string[] - Specifies a list of Default Documents for the Windows Web App.
- detailed
Error booleanLogging Enabled - ftps
State string - handler
Mappings WindowsWeb App Site Config Handler Mapping[] - One or more
handler_mappingblocks as defined below. - health
Check numberEviction Time In Min - The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between
2and10. Only valid in conjunction withhealth_check_path. - health
Check stringPath - The path to the Health Check.
- http2Enabled boolean
- Should the HTTP2 be enabled?
- ip
Restriction stringDefault Action - The Default action for traffic that does not match any
ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - ip
Restrictions WindowsWeb App Site Config Ip Restriction[] - One or more
ip_restrictionblocks as defined above. - linux
Fx stringVersion - load
Balancing stringMode - The Site load balancing. Possible values include:
WeightedRoundRobin,LeastRequests,LeastResponseTime,WeightedTotalTraffic,RequestHash,PerSiteRoundRobin. Defaults toLeastRequestsif omitted. - local
Mysql booleanEnabled - Use Local MySQL. Defaults to
false. - managed
Pipeline stringMode - Managed pipeline mode. Possible values include:
Integrated,Classic. Defaults toIntegrated. - minimum
Tls stringVersion - The configures the minimum version of TLS required for SSL requests. Possible values include:
1.0,1.1,1.2and1.3. Defaults to1.2. - remote
Debugging booleanEnabled - Should Remote Debugging be enabled. Defaults to
false. - remote
Debugging stringVersion - The Remote Debugging Version. Currently only
VS2022is supported. - scm
Ip stringRestriction Default Action - The Default action for traffic that does not match any
scm_ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - scm
Ip WindowsRestrictions Web App Site Config Scm Ip Restriction[] - One or more
scm_ip_restrictionblocks 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_restrictionconfiguration 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_applicationblocks 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.NOTE:
always_onmust be explicitly set tofalsewhen usingFree,F1,D1, orSharedService Plans.- 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_stackblock as defined above. - auto_
heal_ Windowssetting Web App Site Config Auto Heal Setting - A
auto_heal_settingblock 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
corsblock 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 - handler_
mappings Sequence[WindowsWeb App Site Config Handler Mapping] - One or more
handler_mappingblocks as defined below. - health_
check_ inteviction_ time_ in_ min - The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between
2and10. Only valid in conjunction withhealth_check_path. - health_
check_ strpath - The path to the Health Check.
- http2_
enabled bool - Should the HTTP2 be enabled?
- ip_
restriction_ strdefault_ action - The Default action for traffic that does not match any
ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - ip_
restrictions Sequence[WindowsWeb App Site Config Ip Restriction] - One or more
ip_restrictionblocks as defined above. - linux_
fx_ strversion - load_
balancing_ strmode - The Site load balancing. Possible values include:
WeightedRoundRobin,LeastRequests,LeastResponseTime,WeightedTotalTraffic,RequestHash,PerSiteRoundRobin. Defaults toLeastRequestsif omitted. - local_
mysql_ boolenabled - Use Local MySQL. Defaults to
false. - managed_
pipeline_ strmode - Managed pipeline mode. Possible values include:
Integrated,Classic. Defaults toIntegrated. - minimum_
tls_ strversion - The configures the minimum version of TLS required for SSL requests. Possible values include:
1.0,1.1,1.2and1.3. Defaults to1.2. - remote_
debugging_ boolenabled - Should Remote Debugging be enabled. Defaults to
false. - remote_
debugging_ strversion - The Remote Debugging Version. Currently only
VS2022is supported. - scm_
ip_ strrestriction_ default_ action - The Default action for traffic that does not match any
scm_ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - scm_
ip_ Sequence[Windowsrestrictions Web App Site Config Scm Ip Restriction] - One or more
scm_ip_restrictionblocks 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_restrictionconfiguration 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_applicationblocks 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.NOTE:
always_onmust be explicitly set tofalsewhen usingFree,F1,D1, orSharedService Plans.- 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_stackblock as defined above. - auto
Heal Property MapSetting - A
auto_heal_settingblock 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
corsblock 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 - handler
Mappings List<Property Map> - One or more
handler_mappingblocks as defined below. - health
Check NumberEviction Time In Min - The amount of time in minutes that a node can be unhealthy before being removed from the load balancer. Possible values are between
2and10. Only valid in conjunction withhealth_check_path. - health
Check StringPath - The path to the Health Check.
- http2Enabled Boolean
- Should the HTTP2 be enabled?
- ip
Restriction StringDefault Action - The Default action for traffic that does not match any
ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - ip
Restrictions List<Property Map> - One or more
ip_restrictionblocks as defined above. - linux
Fx StringVersion - load
Balancing StringMode - The Site load balancing. Possible values include:
WeightedRoundRobin,LeastRequests,LeastResponseTime,WeightedTotalTraffic,RequestHash,PerSiteRoundRobin. Defaults toLeastRequestsif omitted. - local
Mysql BooleanEnabled - Use Local MySQL. Defaults to
false. - managed
Pipeline StringMode - Managed pipeline mode. Possible values include:
Integrated,Classic. Defaults toIntegrated. - minimum
Tls StringVersion - The configures the minimum version of TLS required for SSL requests. Possible values include:
1.0,1.1,1.2and1.3. Defaults to1.2. - remote
Debugging BooleanEnabled - Should Remote Debugging be enabled. Defaults to
false. - remote
Debugging StringVersion - The Remote Debugging Version. Currently only
VS2022is supported. - scm
Ip StringRestriction Default Action - The Default action for traffic that does not match any
scm_ip_restrictionrule. possible values includeAllowandDeny. Defaults toAllow. - scm
Ip List<Property Map>Restrictions - One or more
scm_ip_restrictionblocks as defined above. - scm
Minimum StringTls Version - 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_restrictionconfiguration 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_applicationblocks 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, WindowsWebAppSiteConfigApplicationStackArgs
- Current
Stack string The Application Stack for the Windows Web App. Possible values include
dotnet,dotnetcore,node,python,php, andjava.NOTE: Whilst this property is Optional omitting it can cause unexpected behaviour, in particular for display of settings in the Azure Portal.
NOTE: Windows Web apps can configure multiple
app_stackproperties, it is recommended to always configure thisOptionalvalue and set it to the primary application stack of your app to ensure correct operation of this resource and display the correct metadata in the Azure Portal.- Docker
Image stringName - The docker image, including tag, to be used. e.g.
azure-app-service/windows/parkingpage:latest. - Docker
Registry stringPassword The User Name to use for authentication against the registry to pull the image.
NOTE:
docker_registry_url,docker_registry_username, anddocker_registry_passwordreplace the use of theapp_settingsvalues ofDOCKER_REGISTRY_SERVER_URL,DOCKER_REGISTRY_SERVER_USERNAMEandDOCKER_REGISTRY_SERVER_PASSWORDrespectively, these values will be managed by the provider and should not be specified in theapp_settingsmap.- Docker
Registry stringUrl - The URL of the container registry where the
docker_image_nameis located. e.g.https://index.docker.ioorhttps://mcr.microsoft.com. This value is required withdocker_image_name. - Docker
Registry stringUsername - The User Name to use for authentication against the registry to pull the image.
- Dotnet
Core stringVersion - The version of .NET to use when
current_stackis set todotnetcore. Possible values includev4.0. - Dotnet
Version string The version of .NET to use when
current_stackis set todotnet. Possible values includev2.0,v3.0,v4.0,v5.0,v6.0,v7.0,v8.0andv9.0.NOTE: The Portal displayed values and the actual underlying API values differ for this setting, as follows: Portal Value | API value :--|--: ASP.NET V3.5 | v2.0 ASP.NET V4.8 | v4.0 .NET 6 (LTS) | v6.0 .NET 7 (STS) | v7.0 .NET 8 (LTS) | v8.0 .NET 9 (STS) | v9.0
- Java
Container string - Java
Container stringVersion - 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_stackis set tojava.NOTE: For currently supported versions, please see the official documentation. Some example values include:
1.8,1.8.0_322,11,11.0.14,17and17.0.2- Node
Version string The version of node to use when
current_stackis set tonode. Possible values are~12,~14,~16,~18,~20and~22.NOTE: This property conflicts with
java_version.- Php
Version string The version of PHP to use when
current_stackis set tophp. Possible values are7.1,7.4andOff.NOTE: The value
Offis used to signify latest supported by the service.- Python bool
- Specifies whether this is a Python app. Defaults to
false. - Tomcat
Version string The version of Tomcat the Java App should use. Conflicts with
java_embedded_server_enabledNOTE: See the official documentation for current supported versions. Some example values include:
10.0,10.0.20.
- Current
Stack string The Application Stack for the Windows Web App. Possible values include
dotnet,dotnetcore,node,python,php, andjava.NOTE: Whilst this property is Optional omitting it can cause unexpected behaviour, in particular for display of settings in the Azure Portal.
NOTE: Windows Web apps can configure multiple
app_stackproperties, it is recommended to always configure thisOptionalvalue and set it to the primary application stack of your app to ensure correct operation of this resource and display the correct metadata in the Azure Portal.- Docker
Image stringName - The docker image, including tag, to be used. e.g.
azure-app-service/windows/parkingpage:latest. - Docker
Registry stringPassword The User Name to use for authentication against the registry to pull the image.
NOTE:
docker_registry_url,docker_registry_username, anddocker_registry_passwordreplace the use of theapp_settingsvalues ofDOCKER_REGISTRY_SERVER_URL,DOCKER_REGISTRY_SERVER_USERNAMEandDOCKER_REGISTRY_SERVER_PASSWORDrespectively, these values will be managed by the provider and should not be specified in theapp_settingsmap.- Docker
Registry stringUrl - The URL of the container registry where the
docker_image_nameis located. e.g.https://index.docker.ioorhttps://mcr.microsoft.com. This value is required withdocker_image_name. - Docker
Registry stringUsername - The User Name to use for authentication against the registry to pull the image.
- Dotnet
Core stringVersion - The version of .NET to use when
current_stackis set todotnetcore. Possible values includev4.0. - Dotnet
Version string The version of .NET to use when
current_stackis set todotnet. Possible values includev2.0,v3.0,v4.0,v5.0,v6.0,v7.0,v8.0andv9.0.NOTE: The Portal displayed values and the actual underlying API values differ for this setting, as follows: Portal Value | API value :--|--: ASP.NET V3.5 | v2.0 ASP.NET V4.8 | v4.0 .NET 6 (LTS) | v6.0 .NET 7 (STS) | v7.0 .NET 8 (LTS) | v8.0 .NET 9 (STS) | v9.0
- Java
Container string - Java
Container stringVersion - 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_stackis set tojava.NOTE: For currently supported versions, please see the official documentation. Some example values include:
1.8,1.8.0_322,11,11.0.14,17and17.0.2- Node
Version string The version of node to use when
current_stackis set tonode. Possible values are~12,~14,~16,~18,~20and~22.NOTE: This property conflicts with
java_version.- Php
Version string The version of PHP to use when
current_stackis set tophp. Possible values are7.1,7.4andOff.NOTE: The value
Offis used to signify latest supported by the service.- Python bool
- Specifies whether this is a Python app. Defaults to
false. - Tomcat
Version string The version of Tomcat the Java App should use. Conflicts with
java_embedded_server_enabledNOTE: See the official documentation for current supported versions. Some example values include:
10.0,10.0.20.
- current
Stack String The Application Stack for the Windows Web App. Possible values include
dotnet,dotnetcore,node,python,php, andjava.NOTE: Whilst this property is Optional omitting it can cause unexpected behaviour, in particular for display of settings in the Azure Portal.
NOTE: Windows Web apps can configure multiple
app_stackproperties, it is recommended to always configure thisOptionalvalue and set it to the primary application stack of your app to ensure correct operation of this resource and display the correct metadata in the Azure Portal.- docker
Image StringName - The docker image, including tag, to be used. e.g.
azure-app-service/windows/parkingpage:latest. - docker
Registry StringPassword The User Name to use for authentication against the registry to pull the image.
NOTE:
docker_registry_url,docker_registry_username, anddocker_registry_passwordreplace the use of theapp_settingsvalues ofDOCKER_REGISTRY_SERVER_URL,DOCKER_REGISTRY_SERVER_USERNAMEandDOCKER_REGISTRY_SERVER_PASSWORDrespectively, these values will be managed by the provider and should not be specified in theapp_settingsmap.- docker
Registry StringUrl - The URL of the container registry where the
docker_image_nameis located. e.g.https://index.docker.ioorhttps://mcr.microsoft.com. This value is required withdocker_image_name. - docker
Registry StringUsername - The User Name to use for authentication against the registry to pull the image.
- dotnet
Core StringVersion - The version of .NET to use when
current_stackis set todotnetcore. Possible values includev4.0. - dotnet
Version String The version of .NET to use when
current_stackis set todotnet. Possible values includev2.0,v3.0,v4.0,v5.0,v6.0,v7.0,v8.0andv9.0.NOTE: The Portal displayed values and the actual underlying API values differ for this setting, as follows: Portal Value | API value :--|--: ASP.NET V3.5 | v2.0 ASP.NET V4.8 | v4.0 .NET 6 (LTS) | v6.0 .NET 7 (STS) | v7.0 .NET 8 (LTS) | v8.0 .NET 9 (STS) | v9.0
- java
Container String - java
Container StringVersion - 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_stackis set tojava.NOTE: For currently supported versions, please see the official documentation. Some example values include:
1.8,1.8.0_322,11,11.0.14,17and17.0.2- node
Version String The version of node to use when
current_stackis set tonode. Possible values are~12,~14,~16,~18,~20and~22.NOTE: This property conflicts with
java_version.- php
Version String The version of PHP to use when
current_stackis set tophp. Possible values are7.1,7.4andOff.NOTE: The value
Offis used to signify latest supported by the service.- python Boolean
- Specifies whether this is a Python app. Defaults to
false. - tomcat
Version String The version of Tomcat the Java App should use. Conflicts with
java_embedded_server_enabledNOTE: See the official documentation for current supported versions. Some example values include:
10.0,10.0.20.
- current
Stack string The Application Stack for the Windows Web App. Possible values include
dotnet,dotnetcore,node,python,php, andjava.NOTE: Whilst this property is Optional omitting it can cause unexpected behaviour, in particular for display of settings in the Azure Portal.
NOTE: Windows Web apps can configure multiple
app_stackproperties, it is recommended to always configure thisOptionalvalue and set it to the primary application stack of your app to ensure correct operation of this resource and display the correct metadata in the Azure Portal.- docker
Image stringName - The docker image, including tag, to be used. e.g.
azure-app-service/windows/parkingpage:latest. - docker
Registry stringPassword The User Name to use for authentication against the registry to pull the image.
NOTE:
docker_registry_url,docker_registry_username, anddocker_registry_passwordreplace the use of theapp_settingsvalues ofDOCKER_REGISTRY_SERVER_URL,DOCKER_REGISTRY_SERVER_USERNAMEandDOCKER_REGISTRY_SERVER_PASSWORDrespectively, these values will be managed by the provider and should not be specified in theapp_settingsmap.- docker
Registry stringUrl - The URL of the container registry where the
docker_image_nameis located. e.g.https://index.docker.ioorhttps://mcr.microsoft.com. This value is required withdocker_image_name. - docker
Registry stringUsername - The User Name to use for authentication against the registry to pull the image.
- dotnet
Core stringVersion - The version of .NET to use when
current_stackis set todotnetcore. Possible values includev4.0. - dotnet
Version string The version of .NET to use when
current_stackis set todotnet. Possible values includev2.0,v3.0,v4.0,v5.0,v6.0,v7.0,v8.0andv9.0.NOTE: The Portal displayed values and the actual underlying API values differ for this setting, as follows: Portal Value | API value :--|--: ASP.NET V3.5 | v2.0 ASP.NET V4.8 | v4.0 .NET 6 (LTS) | v6.0 .NET 7 (STS) | v7.0 .NET 8 (LTS) | v8.0 .NET 9 (STS) | v9.0
- java
Container string - java
Container stringVersion - 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_stackis set tojava.NOTE: For currently supported versions, please see the official documentation. Some example values include:
1.8,1.8.0_322,11,11.0.14,17and17.0.2- node
Version string The version of node to use when
current_stackis set tonode. Possible values are~12,~14,~16,~18,~20and~22.NOTE: This property conflicts with
java_version.- php
Version string The version of PHP to use when
current_stackis set tophp. Possible values are7.1,7.4andOff.NOTE: The value
Offis used to signify latest supported by the service.- python boolean
- Specifies whether this is a Python app. Defaults to
false. - tomcat
Version string The version of Tomcat the Java App should use. Conflicts with
java_embedded_server_enabledNOTE: See the official documentation for current supported versions. Some example values include:
10.0,10.0.20.
- current_
stack str The Application Stack for the Windows Web App. Possible values include
dotnet,dotnetcore,node,python,php, andjava.NOTE: Whilst this property is Optional omitting it can cause unexpected behaviour, in particular for display of settings in the Azure Portal.
NOTE: Windows Web apps can configure multiple
app_stackproperties, it is recommended to always configure thisOptionalvalue and set it to the primary application stack of your app to ensure correct operation of this resource and display the correct metadata in the Azure Portal.- docker_
image_ strname - The docker image, including tag, to be used. e.g.
azure-app-service/windows/parkingpage:latest. - docker_
registry_ strpassword The User Name to use for authentication against the registry to pull the image.
NOTE:
docker_registry_url,docker_registry_username, anddocker_registry_passwordreplace the use of theapp_settingsvalues ofDOCKER_REGISTRY_SERVER_URL,DOCKER_REGISTRY_SERVER_USERNAMEandDOCKER_REGISTRY_SERVER_PASSWORDrespectively, these values will be managed by the provider and should not be specified in theapp_settingsmap.- docker_
registry_ strurl - The URL of the container registry where the
docker_image_nameis located. e.g.https://index.docker.ioorhttps://mcr.microsoft.com. This value is required withdocker_image_name. - docker_
registry_ strusername - The User Name to use for authentication against the registry to pull the image.
- dotnet_
core_ strversion - The version of .NET to use when
current_stackis set todotnetcore. Possible values includev4.0. - dotnet_
version str The version of .NET to use when
current_stackis set todotnet. Possible values includev2.0,v3.0,v4.0,v5.0,v6.0,v7.0,v8.0andv9.0.NOTE: The Portal displayed values and the actual underlying API values differ for this setting, as follows: Portal Value | API value :--|--: ASP.NET V3.5 | v2.0 ASP.NET V4.8 | v4.0 .NET 6 (LTS) | v6.0 .NET 7 (STS) | v7.0 .NET 8 (LTS) | v8.0 .NET 9 (STS) | v9.0
- java_
container str - java_
container_ strversion - 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_stackis set tojava.NOTE: For currently supported versions, please see the official documentation. Some example values include:
1.8,1.8.0_322,11,11.0.14,17and17.0.2- node_
version str The version of node to use when
current_stackis set tonode. Possible values are~12,~14,~16,~18,~20and~22.NOTE: This property conflicts with
java_version.- php_
version str The version of PHP to use when
current_stackis set tophp. Possible values are7.1,7.4andOff.NOTE: The value
Offis used to signify latest supported by the service.- python bool
- Specifies whether this is a Python app. Defaults to
false. - tomcat_
version str The version of Tomcat the Java App should use. Conflicts with
java_embedded_server_enabledNOTE: See the official documentation for current supported versions. Some example values include:
10.0,10.0.20.
- current
Stack String The Application Stack for the Windows Web App. Possible values include
dotnet,dotnetcore,node,python,php, andjava.NOTE: Whilst this property is Optional omitting it can cause unexpected behaviour, in particular for display of settings in the Azure Portal.
NOTE: Windows Web apps can configure multiple
app_stackproperties, it is recommended to always configure thisOptionalvalue and set it to the primary application stack of your app to ensure correct operation of this resource and display the correct metadata in the Azure Portal.- docker
Image StringName - The docker image, including tag, to be used. e.g.
azure-app-service/windows/parkingpage:latest. - docker
Registry StringPassword The User Name to use for authentication against the registry to pull the image.
NOTE:
docker_registry_url,docker_registry_username, anddocker_registry_passwordreplace the use of theapp_settingsvalues ofDOCKER_REGISTRY_SERVER_URL,DOCKER_REGISTRY_SERVER_USERNAMEandDOCKER_REGISTRY_SERVER_PASSWORDrespectively, these values will be managed by the provider and should not be specified in theapp_settingsmap.- docker
Registry StringUrl - The URL of the container registry where the
docker_image_nameis located. e.g.https://index.docker.ioorhttps://mcr.microsoft.com. This value is required withdocker_image_name. - docker
Registry StringUsername - The User Name to use for authentication against the registry to pull the image.
- dotnet
Core StringVersion - The version of .NET to use when
current_stackis set todotnetcore. Possible values includev4.0. - dotnet
Version String The version of .NET to use when
current_stackis set todotnet. Possible values includev2.0,v3.0,v4.0,v5.0,v6.0,v7.0,v8.0andv9.0.NOTE: The Portal displayed values and the actual underlying API values differ for this setting, as follows: Portal Value | API value :--|--: ASP.NET V3.5 | v2.0 ASP.NET V4.8 | v4.0 .NET 6 (LTS) | v6.0 .NET 7 (STS) | v7.0 .NET 8 (LTS) | v8.0 .NET 9 (STS) | v9.0
- java
Container String - java
Container StringVersion - 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_stackis set tojava.NOTE: For currently supported versions, please see the official documentation. Some example values include:
1.8,1.8.0_322,11,11.0.14,17and17.0.2- node
Version String The version of node to use when
current_stackis set tonode. Possible values are~12,~14,~16,~18,~20and~22.NOTE: This property conflicts with
java_version.- php
Version String The version of PHP to use when
current_stackis set tophp. Possible values are7.1,7.4andOff.NOTE: The value
Offis used to signify latest supported by the service.- python Boolean
- Specifies whether this is a Python app. Defaults to
false. - tomcat
Version String The version of Tomcat the Java App should use. Conflicts with
java_embedded_server_enabledNOTE: See the official documentation for current supported versions. Some example values include:
10.0,10.0.20.
WindowsWebAppSiteConfigAutoHealSetting, WindowsWebAppSiteConfigAutoHealSettingArgs
- Action
Windows
Web App Site Config Auto Heal Setting Action - An
actionblock as defined above. - Trigger
Windows
Web App Site Config Auto Heal Setting Trigger - A
triggerblock as defined below.
- Action
Windows
Web App Site Config Auto Heal Setting Action - An
actionblock as defined above. - Trigger
Windows
Web App Site Config Auto Heal Setting Trigger - A
triggerblock as defined below.
- action
Windows
Web App Site Config Auto Heal Setting Action - An
actionblock as defined above. - trigger
Windows
Web App Site Config Auto Heal Setting Trigger - A
triggerblock as defined below.
- action
Windows
Web App Site Config Auto Heal Setting Action - An
actionblock as defined above. - trigger
Windows
Web App Site Config Auto Heal Setting Trigger - A
triggerblock as defined below.
- action
Windows
Web App Site Config Auto Heal Setting Action - An
actionblock as defined above. - trigger
Windows
Web App Site Config Auto Heal Setting Trigger - A
triggerblock as defined below.
- action Property Map
- An
actionblock as defined above. - trigger Property Map
- A
triggerblock as defined below.
WindowsWebAppSiteConfigAutoHealSettingAction, WindowsWebAppSiteConfigAutoHealSettingActionArgs
- 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_actionblock as defined below. - Minimum
Process stringExecution Time - The minimum amount of time in
hh:mm:ssthe 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_actionblock as defined below. - Minimum
Process stringExecution Time - The minimum amount of time in
hh:mm:ssthe 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_actionblock as defined below. - minimum
Process StringExecution Time - The minimum amount of time in
hh:mm:ssthe 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_actionblock as defined below. - minimum
Process stringExecution Time - The minimum amount of time in
hh:mm:ssthe 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_actionblock as defined below. - minimum_
process_ strexecution_ time - The minimum amount of time in
hh:mm:ssthe 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_actionblock as defined below. - minimum
Process StringExecution Time - The minimum amount of time in
hh:mm:ssthe Windows Web App must have been running before the defined action will be run in the event of a trigger.
WindowsWebAppSiteConfigAutoHealSettingActionCustomAction, WindowsWebAppSiteConfigAutoHealSettingActionCustomActionArgs
- 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, WindowsWebAppSiteConfigAutoHealSettingTriggerArgs
- Private
Memory intKb - The amount of Private Memory to be consumed for this rule to trigger. Possible values are between
102400and13631488. - Requests
Windows
Web App Site Config Auto Heal Setting Trigger Requests - A
requestsblock as defined above. - Slow
Request WindowsWeb App Site Config Auto Heal Setting Trigger Slow Request - A
slow_requestblock as defined above. - Slow
Request List<WindowsWith Paths Web App Site Config Auto Heal Setting Trigger Slow Request With Path> - One or more
slow_request_with_pathblocks as defined above. - Status
Codes List<WindowsWeb App Site Config Auto Heal Setting Trigger Status Code> - One or more
status_codeblocks as defined above.
- Private
Memory intKb - The amount of Private Memory to be consumed for this rule to trigger. Possible values are between
102400and13631488. - Requests
Windows
Web App Site Config Auto Heal Setting Trigger Requests - A
requestsblock as defined above. - Slow
Request WindowsWeb App Site Config Auto Heal Setting Trigger Slow Request - A
slow_requestblock as defined above. - Slow
Request []WindowsWith Paths Web App Site Config Auto Heal Setting Trigger Slow Request With Path - One or more
slow_request_with_pathblocks as defined above. - Status
Codes []WindowsWeb App Site Config Auto Heal Setting Trigger Status Code - One or more
status_codeblocks as defined above.
- private
Memory IntegerKb - The amount of Private Memory to be consumed for this rule to trigger. Possible values are between
102400and13631488. - requests
Windows
Web App Site Config Auto Heal Setting Trigger Requests - A
requestsblock as defined above. - slow
Request WindowsWeb App Site Config Auto Heal Setting Trigger Slow Request - A
slow_requestblock as defined above. - slow
Request List<WindowsWith Paths Web App Site Config Auto Heal Setting Trigger Slow Request With Path> - One or more
slow_request_with_pathblocks as defined above. - status
Codes List<WindowsWeb App Site Config Auto Heal Setting Trigger Status Code> - One or more
status_codeblocks as defined above.
- private
Memory numberKb - The amount of Private Memory to be consumed for this rule to trigger. Possible values are between
102400and13631488. - requests
Windows
Web App Site Config Auto Heal Setting Trigger Requests - A
requestsblock as defined above. - slow
Request WindowsWeb App Site Config Auto Heal Setting Trigger Slow Request - A
slow_requestblock as defined above. - slow
Request WindowsWith Paths Web App Site Config Auto Heal Setting Trigger Slow Request With Path[] - One or more
slow_request_with_pathblocks as defined above. - status
Codes WindowsWeb App Site Config Auto Heal Setting Trigger Status Code[] - One or more
status_codeblocks as defined above.
- private_
memory_ intkb - The amount of Private Memory to be consumed for this rule to trigger. Possible values are between
102400and13631488. - requests
Windows
Web App Site Config Auto Heal Setting Trigger Requests - A
requestsblock as defined above. - slow_
request WindowsWeb App Site Config Auto Heal Setting Trigger Slow Request - A
slow_requestblock as defined above. - slow_
request_ Sequence[Windowswith_ paths Web App Site Config Auto Heal Setting Trigger Slow Request With Path] - One or more
slow_request_with_pathblocks as defined above. - status_
codes Sequence[WindowsWeb App Site Config Auto Heal Setting Trigger Status Code] - One or more
status_codeblocks as defined above.
- private
Memory NumberKb - The amount of Private Memory to be consumed for this rule to trigger. Possible values are between
102400and13631488. - requests Property Map
- A
requestsblock as defined above. - slow
Request Property Map - A
slow_requestblock as defined above. - slow
Request List<Property Map>With Paths - One or more
slow_request_with_pathblocks as defined above. - status
Codes List<Property Map> - One or more
status_codeblocks as defined above.
WindowsWebAppSiteConfigAutoHealSettingTriggerRequests, WindowsWebAppSiteConfigAutoHealSettingTriggerRequestsArgs
WindowsWebAppSiteConfigAutoHealSettingTriggerSlowRequest, WindowsWebAppSiteConfigAutoHealSettingTriggerSlowRequestArgs
- count int
- The number of Slow Requests in the time
intervalto 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.
WindowsWebAppSiteConfigAutoHealSettingTriggerSlowRequestWithPath, WindowsWebAppSiteConfigAutoHealSettingTriggerSlowRequestWithPathArgs
- count int
- The number of Slow Requests in the time
intervalto 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, WindowsWebAppSiteConfigAutoHealSettingTriggerStatusCodeArgs
- Count int
- The number of occurrences of the defined
status_codein the specifiedintervalon 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.
500or400-499. Possible values are integers between101and599 - Path string
- The path to which this rule status code applies.
- Sub
Status int - The Request Sub Status of the Status Code.
- Win32Status
Code int - The Win32 Status Code of the Request.
- Count int
- The number of occurrences of the defined
status_codein the specifiedintervalon 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.
500or400-499. Possible values are integers between101and599 - Path string
- The path to which this rule status code applies.
- Sub
Status int - The Request Sub Status of the Status Code.
- Win32Status
Code int - The Win32 Status Code of the Request.
- count Integer
- The number of occurrences of the defined
status_codein the specifiedintervalon 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.
500or400-499. Possible values are integers between101and599 - path String
- The path to which this rule status code applies.
- sub
Status Integer - The Request Sub Status of the Status Code.
- win32Status
Code Integer - The Win32 Status Code of the Request.
- count number
- The number of occurrences of the defined
status_codein the specifiedintervalon 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.
500or400-499. Possible values are integers between101and599 - path string
- The path to which this rule status code applies.
- sub
Status number - The Request Sub Status of the Status Code.
- win32Status
Code number - The Win32 Status Code of the Request.
- count int
- The number of occurrences of the defined
status_codein the specifiedintervalon 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.
500or400-499. Possible values are integers between101and599 - path str
- The path to which this rule status code applies.
- sub_
status int - The Request Sub Status of the Status Code.
- win32_
status_ intcode - The Win32 Status Code of the Request.
- count Number
- The number of occurrences of the defined
status_codein the specifiedintervalon 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.
500or400-499. Possible values are integers between101and599 - path String
- The path to which this rule status code applies.
- sub
Status Number - The Request Sub Status of the Status Code.
- win32Status
Code Number - The Win32 Status Code of the Request.
WindowsWebAppSiteConfigCors, WindowsWebAppSiteConfigCorsArgs
- 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
WindowsWebAppSiteConfigHandlerMapping, WindowsWebAppSiteConfigHandlerMappingArgs
- Extension string
- Specifies which extension to be handled by the specified FastCGI application.
- Script
Processor stringPath - Specifies the absolute path to the FastCGI application.
- Arguments string
- Specifies the command-line arguments to be passed to the script processor.
- Extension string
- Specifies which extension to be handled by the specified FastCGI application.
- Script
Processor stringPath - Specifies the absolute path to the FastCGI application.
- Arguments string
- Specifies the command-line arguments to be passed to the script processor.
- extension String
- Specifies which extension to be handled by the specified FastCGI application.
- script
Processor StringPath - Specifies the absolute path to the FastCGI application.
- arguments String
- Specifies the command-line arguments to be passed to the script processor.
- extension string
- Specifies which extension to be handled by the specified FastCGI application.
- script
Processor stringPath - Specifies the absolute path to the FastCGI application.
- arguments string
- Specifies the command-line arguments to be passed to the script processor.
- extension str
- Specifies which extension to be handled by the specified FastCGI application.
- script_
processor_ strpath - Specifies the absolute path to the FastCGI application.
- arguments str
- Specifies the command-line arguments to be passed to the script processor.
- extension String
- Specifies which extension to be handled by the specified FastCGI application.
- script
Processor StringPath - Specifies the absolute path to the FastCGI application.
- arguments String
- Specifies the command-line arguments to be passed to the script processor.
WindowsWebAppSiteConfigIpRestriction, WindowsWebAppSiteConfigIpRestrictionArgs
- Action string
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - Description string
- The Description of this IP Restriction.
- Headers
Windows
Web App Site Config Ip Restriction Headers - A
headersblock as defined above. - Ip
Address string - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.168.10.1/32 - Name string
- The name which should be used for this
ip_restriction. - Priority int
- The priority value of this
ip_restriction. Defaults to65000. - Service
Tag string - The Service Tag used for this IP Restriction.
- Virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
- Action string
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - Description string
- The Description of this IP Restriction.
- Headers
Windows
Web App Site Config Ip Restriction Headers - A
headersblock as defined above. - Ip
Address string - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.168.10.1/32 - Name string
- The name which should be used for this
ip_restriction. - Priority int
- The priority value of this
ip_restriction. Defaults to65000. - Service
Tag string - The Service Tag used for this IP Restriction.
- Virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
- action String
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - description String
- The Description of this IP Restriction.
- headers
Windows
Web App Site Config Ip Restriction Headers - A
headersblock as defined above. - ip
Address String - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.168.10.1/32 - name String
- The name which should be used for this
ip_restriction. - priority Integer
- The priority value of this
ip_restriction. Defaults to65000. - service
Tag String - The Service Tag used for this IP Restriction.
- virtual
Network StringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
- action string
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - description string
- The Description of this IP Restriction.
- headers
Windows
Web App Site Config Ip Restriction Headers - A
headersblock as defined above. - ip
Address string - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.168.10.1/32 - name string
- The name which should be used for this
ip_restriction. - priority number
- The priority value of this
ip_restriction. Defaults to65000. - service
Tag string - The Service Tag used for this IP Restriction.
- virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
- action str
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - description str
- The Description of this IP Restriction.
- headers
Windows
Web App Site Config Ip Restriction Headers - A
headersblock as defined above. - ip_
address str - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.168.10.1/32 - name str
- The name which should be used for this
ip_restriction. - priority int
- The priority value of this
ip_restriction. Defaults to65000. - service_
tag str - The Service Tag used for this IP Restriction.
- virtual_
network_ strsubnet_ id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
- action String
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - description String
- The Description of this IP Restriction.
- headers Property Map
- A
headersblock as defined above. - ip
Address String - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.168.10.1/32 - name String
- The name which should be used for this
ip_restriction. - priority Number
- The priority value of this
ip_restriction. Defaults to65000. - service
Tag String - The Service Tag used for this IP Restriction.
- virtual
Network StringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
WindowsWebAppSiteConfigIpRestrictionHeaders, WindowsWebAppSiteConfigIpRestrictionHeadersArgs
- 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, WindowsWebAppSiteConfigScmIpRestrictionArgs
- Action string
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - Description string
- The Description of this IP Restriction.
- Headers
Windows
Web App Site Config Scm Ip Restriction Headers - A
headersblock as defined above. - Ip
Address string - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.168.10.1/32 - Name string
- The name which should be used for this
ip_restriction. - Priority int
- The priority value of this
ip_restriction. Defaults to65000. - Service
Tag string - The Service Tag used for this IP Restriction.
- Virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
- Action string
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - Description string
- The Description of this IP Restriction.
- Headers
Windows
Web App Site Config Scm Ip Restriction Headers - A
headersblock as defined above. - Ip
Address string - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.168.10.1/32 - Name string
- The name which should be used for this
ip_restriction. - Priority int
- The priority value of this
ip_restriction. Defaults to65000. - Service
Tag string - The Service Tag used for this IP Restriction.
- Virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
- action String
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - description String
- The Description of this IP Restriction.
- headers
Windows
Web App Site Config Scm Ip Restriction Headers - A
headersblock as defined above. - ip
Address String - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.168.10.1/32 - name String
- The name which should be used for this
ip_restriction. - priority Integer
- The priority value of this
ip_restriction. Defaults to65000. - service
Tag String - The Service Tag used for this IP Restriction.
- virtual
Network StringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
- action string
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - description string
- The Description of this IP Restriction.
- headers
Windows
Web App Site Config Scm Ip Restriction Headers - A
headersblock as defined above. - ip
Address string - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.168.10.1/32 - name string
- The name which should be used for this
ip_restriction. - priority number
- The priority value of this
ip_restriction. Defaults to65000. - service
Tag string - The Service Tag used for this IP Restriction.
- virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
- action str
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - description str
- The Description of this IP Restriction.
- headers
Windows
Web App Site Config Scm Ip Restriction Headers - A
headersblock as defined above. - ip_
address str - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.168.10.1/32 - name str
- The name which should be used for this
ip_restriction. - priority int
- The priority value of this
ip_restriction. Defaults to65000. - service_
tag str - The Service Tag used for this IP Restriction.
- virtual_
network_ strsubnet_ id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
- action String
- The action to take. Possible values are
AlloworDeny. Defaults toAllow. - description String
- The Description of this IP Restriction.
- headers Property Map
- A
headersblock as defined above. - ip
Address String - The CIDR notation of the IP or IP Range to match. For example:
10.0.0.0/24or192.168.10.1/32 - name String
- The name which should be used for this
ip_restriction. - priority Number
- The priority value of this
ip_restriction. Defaults to65000. - service
Tag String - The Service Tag used for this IP Restriction.
- virtual
Network StringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One and only one of
ip_address,service_tagorvirtual_network_subnet_idmust be specified.
WindowsWebAppSiteConfigScmIpRestrictionHeaders, WindowsWebAppSiteConfigScmIpRestrictionHeadersArgs
- 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, WindowsWebAppSiteConfigVirtualApplicationArgs
- 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_directoryblocks 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_directoryblocks 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_directoryblocks 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_directoryblocks 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_directoryblocks 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_directoryblocks as defined below.
WindowsWebAppSiteConfigVirtualApplicationVirtualDirectory, WindowsWebAppSiteConfigVirtualApplicationVirtualDirectoryArgs
- 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, WindowsWebAppSiteCredentialArgs
WindowsWebAppStickySettings, WindowsWebAppStickySettingsArgs
- App
Setting List<string>Names - A list of
app_settingnames 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_stringnames that the Windows Web App will not swap between Slots when a swap operation is triggered.
- App
Setting []stringNames - A list of
app_settingnames that the Windows Web App will not swap between Slots when a swap operation is triggered. - Connection
String []stringNames - A list of
connection_stringnames 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_settingnames 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_stringnames that the Windows Web App will not swap between Slots when a swap operation is triggered.
- app
Setting string[]Names - A list of
app_settingnames that the Windows Web App will not swap between Slots when a swap operation is triggered. - connection
String string[]Names - A list of
connection_stringnames 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_settingnames 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_stringnames 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_settingnames 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_stringnames that the Windows Web App will not swap between Slots when a swap operation is triggered.
WindowsWebAppStorageAccount, WindowsWebAppStorageAccountArgs
- 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
AzureFilesandAzureBlob - 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
AzureFilesandAzureBlob - 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
AzureFilesandAzureBlob - 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
AzureFilesandAzureBlob - 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
AzureFilesandAzureBlob - 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
AzureFilesandAzureBlob - 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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.