Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.11.0 published on Monday, Jun 27, 2022 by Pulumi

AppService

Import

App Services can be imported using the resource id, e.g.

 $ pulumi import azure:appservice/appService:AppService instance1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Web/sites/instance1

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var examplePlan = new Azure.AppService.Plan("examplePlan", new Azure.AppService.PlanArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            Sku = new Azure.AppService.Inputs.PlanSkuArgs
            {
                Tier = "Standard",
                Size = "S1",
            },
        });
        var exampleAppService = new Azure.AppService.AppService("exampleAppService", new Azure.AppService.AppServiceArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            AppServicePlanId = examplePlan.Id,
            SiteConfig = new Azure.AppService.Inputs.AppServiceSiteConfigArgs
            {
                DotnetFrameworkVersion = "v4.0",
                ScmType = "LocalGit",
            },
            AppSettings = 
            {
                { "SOME_KEY", "some-value" },
            },
            ConnectionStrings = 
            {
                new Azure.AppService.Inputs.AppServiceConnectionStringArgs
                {
                    Name = "Database",
                    Type = "SQLServer",
                    Value = "Server=some-server.mydomain.com;Integrated Security=SSPI",
                },
            },
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		examplePlan, err := appservice.NewPlan(ctx, "examplePlan", &appservice.PlanArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			Sku: &appservice.PlanSkuArgs{
				Tier: pulumi.String("Standard"),
				Size: pulumi.String("S1"),
			},
		})
		if err != nil {
			return err
		}
		_, err = appservice.NewAppService(ctx, "exampleAppService", &appservice.AppServiceArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			AppServicePlanId:  examplePlan.ID(),
			SiteConfig: &appservice.AppServiceSiteConfigArgs{
				DotnetFrameworkVersion: pulumi.String("v4.0"),
				ScmType:                pulumi.String("LocalGit"),
			},
			AppSettings: pulumi.StringMap{
				"SOME_KEY": pulumi.String("some-value"),
			},
			ConnectionStrings: appservice.AppServiceConnectionStringArray{
				&appservice.AppServiceConnectionStringArgs{
					Name:  pulumi.String("Database"),
					Type:  pulumi.String("SQLServer"),
					Value: pulumi.String("Server=some-server.mydomain.com;Integrated Security=SSPI"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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

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

        var examplePlan = new Plan("examplePlan", PlanArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .sku(PlanSkuArgs.builder()
                .tier("Standard")
                .size("S1")
                .build())
            .build());

        var exampleAppService = new AppService("exampleAppService", AppServiceArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .appServicePlanId(examplePlan.id())
            .siteConfig(AppServiceSiteConfigArgs.builder()
                .dotnetFrameworkVersion("v4.0")
                .scmType("LocalGit")
                .build())
            .appSettings(Map.of("SOME_KEY", "some-value"))
            .connectionStrings(AppServiceConnectionStringArgs.builder()
                .name("Database")
                .type("SQLServer")
                .value("Server=some-server.mydomain.com;Integrated Security=SSPI")
                .build())
            .build());

    }
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_plan = azure.appservice.Plan("examplePlan",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku=azure.appservice.PlanSkuArgs(
        tier="Standard",
        size="S1",
    ))
example_app_service = azure.appservice.AppService("exampleAppService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    app_service_plan_id=example_plan.id,
    site_config=azure.appservice.AppServiceSiteConfigArgs(
        dotnet_framework_version="v4.0",
        scm_type="LocalGit",
    ),
    app_settings={
        "SOME_KEY": "some-value",
    },
    connection_strings=[azure.appservice.AppServiceConnectionStringArgs(
        name="Database",
        type="SQLServer",
        value="Server=some-server.mydomain.com;Integrated Security=SSPI",
    )])
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const examplePlan = new azure.appservice.Plan("examplePlan", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: {
        tier: "Standard",
        size: "S1",
    },
});
const exampleAppService = new azure.appservice.AppService("exampleAppService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    appServicePlanId: examplePlan.id,
    siteConfig: {
        dotnetFrameworkVersion: "v4.0",
        scmType: "LocalGit",
    },
    appSettings: {
        SOME_KEY: "some-value",
    },
    connectionStrings: [{
        name: "Database",
        type: "SQLServer",
        value: "Server=some-server.mydomain.com;Integrated Security=SSPI",
    }],
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  examplePlan:
    type: azure:appservice:Plan
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      sku:
        tier: Standard
        size: S1
  exampleAppService:
    type: azure:appservice:AppService
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      appServicePlanId: ${examplePlan.id}
      siteConfig:
        dotnetFrameworkVersion: v4.0
        scmType: LocalGit
      appSettings:
        SOME_KEY: some-value
      connectionStrings:
        - name: Database
          type: SQLServer
          value: Server=some-server.mydomain.com;Integrated Security=SSPI

Create a AppService Resource

new AppService(name: string, args: AppServiceArgs, opts?: CustomResourceOptions);
@overload
def AppService(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               app_service_plan_id: Optional[str] = None,
               app_settings: Optional[Mapping[str, str]] = None,
               auth_settings: Optional[AppServiceAuthSettingsArgs] = None,
               backup: Optional[AppServiceBackupArgs] = None,
               client_affinity_enabled: Optional[bool] = None,
               client_cert_enabled: Optional[bool] = None,
               client_cert_mode: Optional[str] = None,
               connection_strings: Optional[Sequence[AppServiceConnectionStringArgs]] = None,
               enabled: Optional[bool] = None,
               https_only: Optional[bool] = None,
               identity: Optional[AppServiceIdentityArgs] = None,
               key_vault_reference_identity_id: Optional[str] = None,
               location: Optional[str] = None,
               logs: Optional[AppServiceLogsArgs] = None,
               name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               site_config: Optional[AppServiceSiteConfigArgs] = None,
               source_control: Optional[AppServiceSourceControlArgs] = None,
               storage_accounts: Optional[Sequence[AppServiceStorageAccountArgs]] = None,
               tags: Optional[Mapping[str, str]] = None)
@overload
def AppService(resource_name: str,
               args: AppServiceArgs,
               opts: Optional[ResourceOptions] = None)
func NewAppService(ctx *Context, name string, args AppServiceArgs, opts ...ResourceOption) (*AppService, error)
public AppService(string name, AppServiceArgs args, CustomResourceOptions? opts = null)
public AppService(String name, AppServiceArgs args)
public AppService(String name, AppServiceArgs args, CustomResourceOptions options)
type: azure:appservice:AppService
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args AppServiceArgs
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 AppServiceArgs
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 AppServiceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AppServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AppServiceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

AppService Resource Properties

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

Inputs

The AppService resource accepts the following input properties:

AppServicePlanId string

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

ResourceGroupName string

The name of the resource group in which to create the App Service.

AppSettings Dictionary<string, string>

A key-value pair of App Settings.

AuthSettings AppServiceAuthSettingsArgs

A auth_settings block as defined below.

Backup AppServiceBackupArgs

A backup block as defined below.

ClientAffinityEnabled bool

Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?

ClientCertEnabled bool

Does the App Service require client certificates for incoming requests? Defaults to false.

ClientCertMode string

Mode of client certificates for this App Service. Possible values are Required, Optional and OptionalInteractiveUser. If this parameter is set, client_cert_enabled must be set to true, otherwise this parameter is ignored.

ConnectionStrings List<AppServiceConnectionStringArgs>

One or more connection_string blocks as defined below.

Enabled bool

Is the App Service Enabled?

HttpsOnly bool

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

Identity AppServiceIdentityArgs

An identity block as defined below.

KeyVaultReferenceIdentityId string

The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. For more information see - Access vaults with a user-assigned identity

Location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Logs AppServiceLogsArgs

A logs block as defined below.

Name string

Specifies the name of the App Service. Changing this forces a new resource to be created.

SiteConfig AppServiceSiteConfigArgs

A site_config block as defined below.

SourceControl AppServiceSourceControlArgs

A Source Control block as defined below

StorageAccounts List<AppServiceStorageAccountArgs>

One or more storage_account blocks as defined below.

Tags Dictionary<string, string>

A mapping of tags to assign to the resource.

AppServicePlanId string

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

ResourceGroupName string

The name of the resource group in which to create the App Service.

AppSettings map[string]string

A key-value pair of App Settings.

AuthSettings AppServiceAuthSettingsArgs

A auth_settings block as defined below.

Backup AppServiceBackupArgs

A backup block as defined below.

ClientAffinityEnabled bool

Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?

ClientCertEnabled bool

Does the App Service require client certificates for incoming requests? Defaults to false.

ClientCertMode string

Mode of client certificates for this App Service. Possible values are Required, Optional and OptionalInteractiveUser. If this parameter is set, client_cert_enabled must be set to true, otherwise this parameter is ignored.

ConnectionStrings []AppServiceConnectionStringArgs

One or more connection_string blocks as defined below.

Enabled bool

Is the App Service Enabled?

HttpsOnly bool

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

Identity AppServiceIdentityArgs

An identity block as defined below.

KeyVaultReferenceIdentityId string

The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. For more information see - Access vaults with a user-assigned identity

Location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Logs AppServiceLogsArgs

A logs block as defined below.

Name string

Specifies the name of the App Service. Changing this forces a new resource to be created.

SiteConfig AppServiceSiteConfigArgs

A site_config block as defined below.

SourceControl AppServiceSourceControlArgs

A Source Control block as defined below

StorageAccounts []AppServiceStorageAccountArgs

One or more storage_account blocks as defined below.

Tags map[string]string

A mapping of tags to assign to the resource.

appServicePlanId String

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

resourceGroupName String

The name of the resource group in which to create the App Service.

appSettings Map<String,String>

A key-value pair of App Settings.

authSettings AppServiceAuthSettingsArgs

A auth_settings block as defined below.

backup AppServiceBackupArgs

A backup block as defined below.

clientAffinityEnabled Boolean

Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?

clientCertEnabled Boolean

Does the App Service require client certificates for incoming requests? Defaults to false.

clientCertMode String

Mode of client certificates for this App Service. Possible values are Required, Optional and OptionalInteractiveUser. If this parameter is set, client_cert_enabled must be set to true, otherwise this parameter is ignored.

connectionStrings List<AppServiceConnectionStringArgs>

One or more connection_string blocks as defined below.

enabled Boolean

Is the App Service Enabled?

httpsOnly Boolean

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

identity AppServiceIdentityArgs

An identity block as defined below.

keyVaultReferenceIdentityId String

The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. For more information see - Access vaults with a user-assigned identity

location String

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

logs AppServiceLogsArgs

A logs block as defined below.

name String

Specifies the name of the App Service. Changing this forces a new resource to be created.

siteConfig AppServiceSiteConfigArgs

A site_config block as defined below.

sourceControl AppServiceSourceControlArgs

A Source Control block as defined below

storageAccounts List<AppServiceStorageAccountArgs>

One or more storage_account blocks as defined below.

tags Map<String,String>

A mapping of tags to assign to the resource.

appServicePlanId string

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

resourceGroupName string

The name of the resource group in which to create the App Service.

appSettings {[key: string]: string}

A key-value pair of App Settings.

authSettings AppServiceAuthSettingsArgs

A auth_settings block as defined below.

backup AppServiceBackupArgs

A backup block as defined below.

clientAffinityEnabled boolean

Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?

clientCertEnabled boolean

Does the App Service require client certificates for incoming requests? Defaults to false.

clientCertMode string

Mode of client certificates for this App Service. Possible values are Required, Optional and OptionalInteractiveUser. If this parameter is set, client_cert_enabled must be set to true, otherwise this parameter is ignored.

connectionStrings AppServiceConnectionStringArgs[]

One or more connection_string blocks as defined below.

enabled boolean

Is the App Service Enabled?

httpsOnly boolean

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

identity AppServiceIdentityArgs

An identity block as defined below.

keyVaultReferenceIdentityId string

The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. For more information see - Access vaults with a user-assigned identity

location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

logs AppServiceLogsArgs

A logs block as defined below.

name string

Specifies the name of the App Service. Changing this forces a new resource to be created.

siteConfig AppServiceSiteConfigArgs

A site_config block as defined below.

sourceControl AppServiceSourceControlArgs

A Source Control block as defined below

storageAccounts AppServiceStorageAccountArgs[]

One or more storage_account blocks as defined below.

tags {[key: string]: string}

A mapping of tags to assign to the resource.

app_service_plan_id str

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

resource_group_name str

The name of the resource group in which to create the App Service.

app_settings Mapping[str, str]

A key-value pair of App Settings.

auth_settings AppServiceAuthSettingsArgs

A auth_settings block as defined below.

backup AppServiceBackupArgs

A backup block as defined below.

client_affinity_enabled bool

Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?

client_cert_enabled bool

Does the App Service require client certificates for incoming requests? Defaults to false.

client_cert_mode str

Mode of client certificates for this App Service. Possible values are Required, Optional and OptionalInteractiveUser. If this parameter is set, client_cert_enabled must be set to true, otherwise this parameter is ignored.

connection_strings Sequence[AppServiceConnectionStringArgs]

One or more connection_string blocks as defined below.

enabled bool

Is the App Service Enabled?

https_only bool

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

identity AppServiceIdentityArgs

An identity block as defined below.

key_vault_reference_identity_id str

The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. For more information see - Access vaults with a user-assigned identity

location str

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

logs AppServiceLogsArgs

A logs block as defined below.

name str

Specifies the name of the App Service. Changing this forces a new resource to be created.

site_config AppServiceSiteConfigArgs

A site_config block as defined below.

source_control AppServiceSourceControlArgs

A Source Control block as defined below

storage_accounts Sequence[AppServiceStorageAccountArgs]

One or more storage_account blocks as defined below.

tags Mapping[str, str]

A mapping of tags to assign to the resource.

appServicePlanId String

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

resourceGroupName String

The name of the resource group in which to create the App Service.

appSettings Map<String>

A key-value pair of App Settings.

authSettings Property Map

A auth_settings block as defined below.

backup Property Map

A backup block as defined below.

clientAffinityEnabled Boolean

Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?

clientCertEnabled Boolean

Does the App Service require client certificates for incoming requests? Defaults to false.

clientCertMode String

Mode of client certificates for this App Service. Possible values are Required, Optional and OptionalInteractiveUser. If this parameter is set, client_cert_enabled must be set to true, otherwise this parameter is ignored.

connectionStrings List<Property Map>

One or more connection_string blocks as defined below.

enabled Boolean

Is the App Service Enabled?

httpsOnly Boolean

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

identity Property Map

An identity block as defined below.

keyVaultReferenceIdentityId String

The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. For more information see - Access vaults with a user-assigned identity

location String

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

logs Property Map

A logs block as defined below.

name String

Specifies the name of the App Service. Changing this forces a new resource to be created.

siteConfig Property Map

A site_config block as defined below.

sourceControl Property Map

A Source Control block as defined below

storageAccounts List<Property Map>

One or more storage_account blocks as defined below.

tags Map<String>

A mapping of tags to assign to the resource.

Outputs

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

CustomDomainVerificationId string

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

DefaultSiteHostname string

The Default Hostname associated with the App Service - such as mysite.azurewebsites.net

Id string

The provider-assigned unique ID for this managed resource.

OutboundIpAddressLists List<string>

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

OutboundIpAddresses string

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

PossibleOutboundIpAddressLists List<string>

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12", "52.143.43.17"] - not all of which are necessarily in use. Superset of outbound_ip_address_list.

PossibleOutboundIpAddresses string

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

SiteCredentials List<AppServiceSiteCredential>

A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.

CustomDomainVerificationId string

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

DefaultSiteHostname string

The Default Hostname associated with the App Service - such as mysite.azurewebsites.net

Id string

The provider-assigned unique ID for this managed resource.

OutboundIpAddressLists []string

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

OutboundIpAddresses string

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

PossibleOutboundIpAddressLists []string

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12", "52.143.43.17"] - not all of which are necessarily in use. Superset of outbound_ip_address_list.

PossibleOutboundIpAddresses string

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

SiteCredentials []AppServiceSiteCredential

A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.

customDomainVerificationId String

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

defaultSiteHostname String

The Default Hostname associated with the App Service - such as mysite.azurewebsites.net

id String

The provider-assigned unique ID for this managed resource.

outboundIpAddressLists List<String>

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

outboundIpAddresses String

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

possibleOutboundIpAddressLists List<String>

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12", "52.143.43.17"] - not all of which are necessarily in use. Superset of outbound_ip_address_list.

possibleOutboundIpAddresses String

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

siteCredentials List<AppServiceSiteCredential>

A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.

customDomainVerificationId string

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

defaultSiteHostname string

The Default Hostname associated with the App Service - such as mysite.azurewebsites.net

id string

The provider-assigned unique ID for this managed resource.

outboundIpAddressLists string[]

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

outboundIpAddresses string

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

possibleOutboundIpAddressLists string[]

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12", "52.143.43.17"] - not all of which are necessarily in use. Superset of outbound_ip_address_list.

possibleOutboundIpAddresses string

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

siteCredentials AppServiceSiteCredential[]

A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.

custom_domain_verification_id str

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

default_site_hostname str

The Default Hostname associated with the App Service - such as mysite.azurewebsites.net

id str

The provider-assigned unique ID for this managed resource.

outbound_ip_address_lists Sequence[str]

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

outbound_ip_addresses str

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

possible_outbound_ip_address_lists Sequence[str]

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12", "52.143.43.17"] - not all of which are necessarily in use. Superset of outbound_ip_address_list.

possible_outbound_ip_addresses str

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

site_credentials Sequence[AppServiceSiteCredential]

A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.

customDomainVerificationId String

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

defaultSiteHostname String

The Default Hostname associated with the App Service - such as mysite.azurewebsites.net

id String

The provider-assigned unique ID for this managed resource.

outboundIpAddressLists List<String>

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

outboundIpAddresses String

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

possibleOutboundIpAddressLists List<String>

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12", "52.143.43.17"] - not all of which are necessarily in use. Superset of outbound_ip_address_list.

possibleOutboundIpAddresses String

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

siteCredentials List<Property Map>

A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.

Look up an Existing AppService Resource

Get an existing AppService 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?: AppServiceState, opts?: CustomResourceOptions): AppService
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_service_plan_id: Optional[str] = None,
        app_settings: Optional[Mapping[str, str]] = None,
        auth_settings: Optional[AppServiceAuthSettingsArgs] = None,
        backup: Optional[AppServiceBackupArgs] = None,
        client_affinity_enabled: Optional[bool] = None,
        client_cert_enabled: Optional[bool] = None,
        client_cert_mode: Optional[str] = None,
        connection_strings: Optional[Sequence[AppServiceConnectionStringArgs]] = None,
        custom_domain_verification_id: Optional[str] = None,
        default_site_hostname: Optional[str] = None,
        enabled: Optional[bool] = None,
        https_only: Optional[bool] = None,
        identity: Optional[AppServiceIdentityArgs] = None,
        key_vault_reference_identity_id: Optional[str] = None,
        location: Optional[str] = None,
        logs: Optional[AppServiceLogsArgs] = None,
        name: Optional[str] = None,
        outbound_ip_address_lists: Optional[Sequence[str]] = None,
        outbound_ip_addresses: Optional[str] = None,
        possible_outbound_ip_address_lists: Optional[Sequence[str]] = None,
        possible_outbound_ip_addresses: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        site_config: Optional[AppServiceSiteConfigArgs] = None,
        site_credentials: Optional[Sequence[AppServiceSiteCredentialArgs]] = None,
        source_control: Optional[AppServiceSourceControlArgs] = None,
        storage_accounts: Optional[Sequence[AppServiceStorageAccountArgs]] = None,
        tags: Optional[Mapping[str, str]] = None) -> AppService
func GetAppService(ctx *Context, name string, id IDInput, state *AppServiceState, opts ...ResourceOption) (*AppService, error)
public static AppService Get(string name, Input<string> id, AppServiceState? state, CustomResourceOptions? opts = null)
public static AppService get(String name, Output<String> id, AppServiceState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AppServicePlanId string

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

AppSettings Dictionary<string, string>

A key-value pair of App Settings.

AuthSettings AppServiceAuthSettingsArgs

A auth_settings block as defined below.

Backup AppServiceBackupArgs

A backup block as defined below.

ClientAffinityEnabled bool

Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?

ClientCertEnabled bool

Does the App Service require client certificates for incoming requests? Defaults to false.

ClientCertMode string

Mode of client certificates for this App Service. Possible values are Required, Optional and OptionalInteractiveUser. If this parameter is set, client_cert_enabled must be set to true, otherwise this parameter is ignored.

ConnectionStrings List<AppServiceConnectionStringArgs>

One or more connection_string blocks as defined below.

CustomDomainVerificationId string

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

DefaultSiteHostname string

The Default Hostname associated with the App Service - such as mysite.azurewebsites.net

Enabled bool

Is the App Service Enabled?

HttpsOnly bool

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

Identity AppServiceIdentityArgs

An identity block as defined below.

KeyVaultReferenceIdentityId string

The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. For more information see - Access vaults with a user-assigned identity

Location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Logs AppServiceLogsArgs

A logs block as defined below.

Name string

Specifies the name of the App Service. Changing this forces a new resource to be created.

OutboundIpAddressLists List<string>

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

OutboundIpAddresses string

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

PossibleOutboundIpAddressLists List<string>

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12", "52.143.43.17"] - not all of which are necessarily in use. Superset of outbound_ip_address_list.

PossibleOutboundIpAddresses string

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

ResourceGroupName string

The name of the resource group in which to create the App Service.

SiteConfig AppServiceSiteConfigArgs

A site_config block as defined below.

SiteCredentials List<AppServiceSiteCredentialArgs>

A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.

SourceControl AppServiceSourceControlArgs

A Source Control block as defined below

StorageAccounts List<AppServiceStorageAccountArgs>

One or more storage_account blocks as defined below.

Tags Dictionary<string, string>

A mapping of tags to assign to the resource.

AppServicePlanId string

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

AppSettings map[string]string

A key-value pair of App Settings.

AuthSettings AppServiceAuthSettingsArgs

A auth_settings block as defined below.

Backup AppServiceBackupArgs

A backup block as defined below.

ClientAffinityEnabled bool

Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?

ClientCertEnabled bool

Does the App Service require client certificates for incoming requests? Defaults to false.

ClientCertMode string

Mode of client certificates for this App Service. Possible values are Required, Optional and OptionalInteractiveUser. If this parameter is set, client_cert_enabled must be set to true, otherwise this parameter is ignored.

ConnectionStrings []AppServiceConnectionStringArgs

One or more connection_string blocks as defined below.

CustomDomainVerificationId string

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

DefaultSiteHostname string

The Default Hostname associated with the App Service - such as mysite.azurewebsites.net

Enabled bool

Is the App Service Enabled?

HttpsOnly bool

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

Identity AppServiceIdentityArgs

An identity block as defined below.

KeyVaultReferenceIdentityId string

The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. For more information see - Access vaults with a user-assigned identity

Location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Logs AppServiceLogsArgs

A logs block as defined below.

Name string

Specifies the name of the App Service. Changing this forces a new resource to be created.

OutboundIpAddressLists []string

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

OutboundIpAddresses string

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

PossibleOutboundIpAddressLists []string

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12", "52.143.43.17"] - not all of which are necessarily in use. Superset of outbound_ip_address_list.

PossibleOutboundIpAddresses string

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

ResourceGroupName string

The name of the resource group in which to create the App Service.

SiteConfig AppServiceSiteConfigArgs

A site_config block as defined below.

SiteCredentials []AppServiceSiteCredentialArgs

A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.

SourceControl AppServiceSourceControlArgs

A Source Control block as defined below

StorageAccounts []AppServiceStorageAccountArgs

One or more storage_account blocks as defined below.

Tags map[string]string

A mapping of tags to assign to the resource.

appServicePlanId String

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

appSettings Map<String,String>

A key-value pair of App Settings.

authSettings AppServiceAuthSettingsArgs

A auth_settings block as defined below.

backup AppServiceBackupArgs

A backup block as defined below.

clientAffinityEnabled Boolean

Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?

clientCertEnabled Boolean

Does the App Service require client certificates for incoming requests? Defaults to false.

clientCertMode String

Mode of client certificates for this App Service. Possible values are Required, Optional and OptionalInteractiveUser. If this parameter is set, client_cert_enabled must be set to true, otherwise this parameter is ignored.

connectionStrings List<AppServiceConnectionStringArgs>

One or more connection_string blocks as defined below.

customDomainVerificationId String

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

defaultSiteHostname String

The Default Hostname associated with the App Service - such as mysite.azurewebsites.net

enabled Boolean

Is the App Service Enabled?

httpsOnly Boolean

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

identity AppServiceIdentityArgs

An identity block as defined below.

keyVaultReferenceIdentityId String

The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. For more information see - Access vaults with a user-assigned identity

location String

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

logs AppServiceLogsArgs

A logs block as defined below.

name String

Specifies the name of the App Service. Changing this forces a new resource to be created.

outboundIpAddressLists List<String>

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

outboundIpAddresses String

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

possibleOutboundIpAddressLists List<String>

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12", "52.143.43.17"] - not all of which are necessarily in use. Superset of outbound_ip_address_list.

possibleOutboundIpAddresses String

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

resourceGroupName String

The name of the resource group in which to create the App Service.

siteConfig AppServiceSiteConfigArgs

A site_config block as defined below.

siteCredentials List<AppServiceSiteCredentialArgs>

A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.

sourceControl AppServiceSourceControlArgs

A Source Control block as defined below

storageAccounts List<AppServiceStorageAccountArgs>

One or more storage_account blocks as defined below.

tags Map<String,String>

A mapping of tags to assign to the resource.

appServicePlanId string

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

appSettings {[key: string]: string}

A key-value pair of App Settings.

authSettings AppServiceAuthSettingsArgs

A auth_settings block as defined below.

backup AppServiceBackupArgs

A backup block as defined below.

clientAffinityEnabled boolean

Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?

clientCertEnabled boolean

Does the App Service require client certificates for incoming requests? Defaults to false.

clientCertMode string

Mode of client certificates for this App Service. Possible values are Required, Optional and OptionalInteractiveUser. If this parameter is set, client_cert_enabled must be set to true, otherwise this parameter is ignored.

connectionStrings AppServiceConnectionStringArgs[]

One or more connection_string blocks as defined below.

customDomainVerificationId string

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

defaultSiteHostname string

The Default Hostname associated with the App Service - such as mysite.azurewebsites.net

enabled boolean

Is the App Service Enabled?

httpsOnly boolean

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

identity AppServiceIdentityArgs

An identity block as defined below.

keyVaultReferenceIdentityId string

The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. For more information see - Access vaults with a user-assigned identity

location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

logs AppServiceLogsArgs

A logs block as defined below.

name string

Specifies the name of the App Service. Changing this forces a new resource to be created.

outboundIpAddressLists string[]

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

outboundIpAddresses string

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

possibleOutboundIpAddressLists string[]

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12", "52.143.43.17"] - not all of which are necessarily in use. Superset of outbound_ip_address_list.

possibleOutboundIpAddresses string

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

resourceGroupName string

The name of the resource group in which to create the App Service.

siteConfig AppServiceSiteConfigArgs

A site_config block as defined below.

siteCredentials AppServiceSiteCredentialArgs[]

A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.

sourceControl AppServiceSourceControlArgs

A Source Control block as defined below

storageAccounts AppServiceStorageAccountArgs[]

One or more storage_account blocks as defined below.

tags {[key: string]: string}

A mapping of tags to assign to the resource.

app_service_plan_id str

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

app_settings Mapping[str, str]

A key-value pair of App Settings.

auth_settings AppServiceAuthSettingsArgs

A auth_settings block as defined below.

backup AppServiceBackupArgs

A backup block as defined below.

client_affinity_enabled bool

Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?

client_cert_enabled bool

Does the App Service require client certificates for incoming requests? Defaults to false.

client_cert_mode str

Mode of client certificates for this App Service. Possible values are Required, Optional and OptionalInteractiveUser. If this parameter is set, client_cert_enabled must be set to true, otherwise this parameter is ignored.

connection_strings Sequence[AppServiceConnectionStringArgs]

One or more connection_string blocks as defined below.

custom_domain_verification_id str

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

default_site_hostname str

The Default Hostname associated with the App Service - such as mysite.azurewebsites.net

enabled bool

Is the App Service Enabled?

https_only bool

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

identity AppServiceIdentityArgs

An identity block as defined below.

key_vault_reference_identity_id str

The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. For more information see - Access vaults with a user-assigned identity

location str

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

logs AppServiceLogsArgs

A logs block as defined below.

name str

Specifies the name of the App Service. Changing this forces a new resource to be created.

outbound_ip_address_lists Sequence[str]

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

outbound_ip_addresses str

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

possible_outbound_ip_address_lists Sequence[str]

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12", "52.143.43.17"] - not all of which are necessarily in use. Superset of outbound_ip_address_list.

possible_outbound_ip_addresses str

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

resource_group_name str

The name of the resource group in which to create the App Service.

site_config AppServiceSiteConfigArgs

A site_config block as defined below.

site_credentials Sequence[AppServiceSiteCredentialArgs]

A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.

source_control AppServiceSourceControlArgs

A Source Control block as defined below

storage_accounts Sequence[AppServiceStorageAccountArgs]

One or more storage_account blocks as defined below.

tags Mapping[str, str]

A mapping of tags to assign to the resource.

appServicePlanId String

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

appSettings Map<String>

A key-value pair of App Settings.

authSettings Property Map

A auth_settings block as defined below.

backup Property Map

A backup block as defined below.

clientAffinityEnabled Boolean

Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?

clientCertEnabled Boolean

Does the App Service require client certificates for incoming requests? Defaults to false.

clientCertMode String

Mode of client certificates for this App Service. Possible values are Required, Optional and OptionalInteractiveUser. If this parameter is set, client_cert_enabled must be set to true, otherwise this parameter is ignored.

connectionStrings List<Property Map>

One or more connection_string blocks as defined below.

customDomainVerificationId String

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

defaultSiteHostname String

The Default Hostname associated with the App Service - such as mysite.azurewebsites.net

enabled Boolean

Is the App Service Enabled?

httpsOnly Boolean

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

identity Property Map

An identity block as defined below.

keyVaultReferenceIdentityId String

The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. For more information see - Access vaults with a user-assigned identity

location String

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

logs Property Map

A logs block as defined below.

name String

Specifies the name of the App Service. Changing this forces a new resource to be created.

outboundIpAddressLists List<String>

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

outboundIpAddresses String

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

possibleOutboundIpAddressLists List<String>

A list of outbound IP addresses - such as ["52.23.25.3", "52.143.43.12", "52.143.43.17"] - not all of which are necessarily in use. Superset of outbound_ip_address_list.

possibleOutboundIpAddresses String

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

resourceGroupName String

The name of the resource group in which to create the App Service.

siteConfig Property Map

A site_config block as defined below.

siteCredentials List<Property Map>

A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.

sourceControl Property Map

A Source Control block as defined below

storageAccounts List<Property Map>

One or more storage_account blocks as defined below.

tags Map<String>

A mapping of tags to assign to the resource.

Supporting Types

AppServiceAuthSettings

Enabled bool

Is Authentication enabled?

ActiveDirectory AppServiceAuthSettingsActiveDirectory

A active_directory block as defined below.

AdditionalLoginParams Dictionary<string, string>

Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".

AllowedExternalRedirectUrls List<string>

External URLs that can be redirected to as part of logging in or logging out of the app.

DefaultProvider string

The default provider to use when multiple providers have been set up. Possible values are AzureActiveDirectory, Facebook, Google, MicrosoftAccount and Twitter.

Facebook AppServiceAuthSettingsFacebook

A facebook block as defined below.

Google AppServiceAuthSettingsGoogle

A google block as defined below.

Issuer string

Issuer URI. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.

Microsoft AppServiceAuthSettingsMicrosoft

A microsoft block as defined below.

RuntimeVersion string

The runtime version of the Authentication/Authorization module.

TokenRefreshExtensionHours double

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

TokenStoreEnabled bool

If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to false.

Twitter AppServiceAuthSettingsTwitter

A twitter block as defined below.

UnauthenticatedClientAction string

The action to take when an unauthenticated client attempts to access the app. Possible values are AllowAnonymous and RedirectToLoginPage.

Enabled bool

Is Authentication enabled?

ActiveDirectory AppServiceAuthSettingsActiveDirectory

A active_directory block as defined below.

AdditionalLoginParams map[string]string

Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".

AllowedExternalRedirectUrls []string

External URLs that can be redirected to as part of logging in or logging out of the app.

DefaultProvider string

The default provider to use when multiple providers have been set up. Possible values are AzureActiveDirectory, Facebook, Google, MicrosoftAccount and Twitter.

Facebook AppServiceAuthSettingsFacebook

A facebook block as defined below.

Google AppServiceAuthSettingsGoogle

A google block as defined below.

Issuer string

Issuer URI. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.

Microsoft AppServiceAuthSettingsMicrosoft

A microsoft block as defined below.

RuntimeVersion string

The runtime version of the Authentication/Authorization module.

TokenRefreshExtensionHours float64

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

TokenStoreEnabled bool

If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to false.

Twitter AppServiceAuthSettingsTwitter

A twitter block as defined below.

UnauthenticatedClientAction string

The action to take when an unauthenticated client attempts to access the app. Possible values are AllowAnonymous and RedirectToLoginPage.

enabled Boolean

Is Authentication enabled?

activeDirectory AppServiceAuthSettingsActiveDirectory

A active_directory block as defined below.

additionalLoginParams Map<String,String>

Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".

allowedExternalRedirectUrls List<String>

External URLs that can be redirected to as part of logging in or logging out of the app.

defaultProvider String

The default provider to use when multiple providers have been set up. Possible values are AzureActiveDirectory, Facebook, Google, MicrosoftAccount and Twitter.

facebook AppServiceAuthSettingsFacebook

A facebook block as defined below.

google AppServiceAuthSettingsGoogle

A google block as defined below.

issuer String

Issuer URI. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.

microsoft AppServiceAuthSettingsMicrosoft

A microsoft block as defined below.

runtimeVersion String

The runtime version of the Authentication/Authorization module.

tokenRefreshExtensionHours Double

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

tokenStoreEnabled Boolean

If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to false.

twitter AppServiceAuthSettingsTwitter

A twitter block as defined below.

unauthenticatedClientAction String

The action to take when an unauthenticated client attempts to access the app. Possible values are AllowAnonymous and RedirectToLoginPage.

enabled boolean

Is Authentication enabled?

activeDirectory AppServiceAuthSettingsActiveDirectory

A active_directory block as defined below.

additionalLoginParams {[key: string]: string}

Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".

allowedExternalRedirectUrls string[]

External URLs that can be redirected to as part of logging in or logging out of the app.

defaultProvider string

The default provider to use when multiple providers have been set up. Possible values are AzureActiveDirectory, Facebook, Google, MicrosoftAccount and Twitter.

facebook AppServiceAuthSettingsFacebook

A facebook block as defined below.

google AppServiceAuthSettingsGoogle

A google block as defined below.

issuer string

Issuer URI. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.

microsoft AppServiceAuthSettingsMicrosoft

A microsoft block as defined below.

runtimeVersion string

The runtime version of the Authentication/Authorization module.

tokenRefreshExtensionHours number

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

tokenStoreEnabled boolean

If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to false.

twitter AppServiceAuthSettingsTwitter

A twitter block as defined below.

unauthenticatedClientAction string

The action to take when an unauthenticated client attempts to access the app. Possible values are AllowAnonymous and RedirectToLoginPage.

enabled bool

Is Authentication enabled?

active_directory AppServiceAuthSettingsActiveDirectory

A active_directory block as defined below.

additional_login_params Mapping[str, str]

Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".

allowed_external_redirect_urls Sequence[str]

External URLs that can be redirected to as part of logging in or logging out of the app.

default_provider str

The default provider to use when multiple providers have been set up. Possible values are AzureActiveDirectory, Facebook, Google, MicrosoftAccount and Twitter.

facebook AppServiceAuthSettingsFacebook

A facebook block as defined below.

google AppServiceAuthSettingsGoogle

A google block as defined below.

issuer str

Issuer URI. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.

microsoft AppServiceAuthSettingsMicrosoft

A microsoft block as defined below.

runtime_version str

The runtime version of the Authentication/Authorization module.

token_refresh_extension_hours float

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

token_store_enabled bool

If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to false.

twitter AppServiceAuthSettingsTwitter

A twitter block as defined below.

unauthenticated_client_action str

The action to take when an unauthenticated client attempts to access the app. Possible values are AllowAnonymous and RedirectToLoginPage.

enabled Boolean

Is Authentication enabled?

activeDirectory Property Map

A active_directory block as defined below.

additionalLoginParams Map<String>

Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".

allowedExternalRedirectUrls List<String>

External URLs that can be redirected to as part of logging in or logging out of the app.

defaultProvider String

The default provider to use when multiple providers have been set up. Possible values are AzureActiveDirectory, Facebook, Google, MicrosoftAccount and Twitter.

facebook Property Map

A facebook block as defined below.

google Property Map

A google block as defined below.

issuer String

Issuer URI. 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 microsoft block as defined below.

runtimeVersion String

The runtime version of the Authentication/Authorization module.

tokenRefreshExtensionHours Number

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

tokenStoreEnabled Boolean

If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to false.

twitter Property Map

A twitter block as defined below.

unauthenticatedClientAction String

The action to take when an unauthenticated client attempts to access the app. Possible values are AllowAnonymous and RedirectToLoginPage.

AppServiceAuthSettingsActiveDirectory

ClientId string

The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.

AllowedAudiences List<string>

Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

ClientSecret string

The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.

ClientId string

The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.

AllowedAudiences []string

Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

ClientSecret string

The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.

clientId String

The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.

allowedAudiences List<String>

Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

clientSecret String

The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.

clientId string

The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.

allowedAudiences string[]

Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

clientSecret string

The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.

client_id str

The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.

allowed_audiences Sequence[str]

Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

client_secret str

The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.

clientId String

The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.

allowedAudiences List<String>

Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

clientSecret String

The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.

AppServiceAuthSettingsFacebook

AppId string

The App ID of the Facebook app used for login

AppSecret string

The App Secret of the Facebook app used for Facebook login.

OauthScopes List<string>

The OAuth 2.0 scopes that will be requested as part of Facebook login authentication. https://developers.facebook.com/docs/facebook-login

AppId string

The App ID of the Facebook app used for login

AppSecret string

The App Secret of the Facebook app used for Facebook login.

OauthScopes []string

The OAuth 2.0 scopes that will be requested as part of Facebook login authentication. https://developers.facebook.com/docs/facebook-login

appId String

The App ID of the Facebook app used for login

appSecret String

The App Secret of the Facebook app used for Facebook login.

oauthScopes List<String>

The OAuth 2.0 scopes that will be requested as part of Facebook login authentication. https://developers.facebook.com/docs/facebook-login

appId string

The App ID of the Facebook app used for login

appSecret string

The App Secret of the Facebook app used for Facebook login.

oauthScopes string[]

The OAuth 2.0 scopes that will be requested as part of Facebook login authentication. https://developers.facebook.com/docs/facebook-login

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.

oauth_scopes Sequence[str]

The OAuth 2.0 scopes that will be requested as part of Facebook login authentication. https://developers.facebook.com/docs/facebook-login

appId String

The App ID of the Facebook app used for login

appSecret String

The App Secret of the Facebook app used for Facebook login.

oauthScopes List<String>

The OAuth 2.0 scopes that will be requested as part of Facebook login authentication. https://developers.facebook.com/docs/facebook-login

AppServiceAuthSettingsGoogle

ClientId string

The OpenID Connect Client ID for the Google web application.

ClientSecret string

The client secret associated with the Google web application.

OauthScopes List<string>

The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. https://developers.google.com/identity/sign-in/web/

ClientId string

The OpenID Connect Client ID for the Google web application.

ClientSecret string

The client secret associated with the Google web application.

OauthScopes []string

The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. https://developers.google.com/identity/sign-in/web/

clientId String

The OpenID Connect Client ID for the Google web application.

clientSecret String

The client secret associated with the Google web application.

oauthScopes List<String>

The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. https://developers.google.com/identity/sign-in/web/

clientId string

The OpenID Connect Client ID for the Google web application.

clientSecret string

The client secret associated with the Google web application.

oauthScopes string[]

The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. https://developers.google.com/identity/sign-in/web/

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.

oauth_scopes Sequence[str]

The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. https://developers.google.com/identity/sign-in/web/

clientId String

The OpenID Connect Client ID for the Google web application.

clientSecret String

The client secret associated with the Google web application.

oauthScopes List<String>

The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. https://developers.google.com/identity/sign-in/web/

AppServiceAuthSettingsMicrosoft

ClientId string

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

ClientSecret string

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

OauthScopes List<string>

The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx

ClientId string

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

ClientSecret string

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

OauthScopes []string

The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx

clientId String

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

clientSecret String

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

oauthScopes List<String>

The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx

clientId string

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

clientSecret string

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

oauthScopes string[]

The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx

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.

oauth_scopes Sequence[str]

The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx

clientId String

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

clientSecret String

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

oauthScopes List<String>

The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx

AppServiceAuthSettingsTwitter

AppServiceBackup

Name string

Specifies the name for this Backup.

Schedule AppServiceBackupSchedule

A schedule block as defined below.

StorageAccountUrl string

The SAS URL to a Storage Container where Backups should be saved.

Enabled bool

Is this Backup enabled?

Name string

Specifies the name for this Backup.

Schedule AppServiceBackupSchedule

A schedule block as defined below.

StorageAccountUrl string

The SAS URL to a Storage Container where Backups should be saved.

Enabled bool

Is this Backup enabled?

name String

Specifies the name for this Backup.

schedule AppServiceBackupSchedule

A schedule block as defined below.

storageAccountUrl String

The SAS URL to a Storage Container where Backups should be saved.

enabled Boolean

Is this Backup enabled?

name string

Specifies the name for this Backup.

schedule AppServiceBackupSchedule

A schedule block as defined below.

storageAccountUrl string

The SAS URL to a Storage Container where Backups should be saved.

enabled boolean

Is this Backup enabled?

name str

Specifies the name for this Backup.

schedule AppServiceBackupSchedule

A schedule block as defined below.

storage_account_url str

The SAS URL to a Storage Container where Backups should be saved.

enabled bool

Is this Backup enabled?

name String

Specifies the name for this Backup.

schedule Property Map

A schedule block as defined below.

storageAccountUrl String

The SAS URL to a Storage Container where Backups should be saved.

enabled Boolean

Is this Backup enabled?

AppServiceBackupSchedule

FrequencyInterval int

Sets how often the backup should be executed.

FrequencyUnit string

Sets the unit of time for how often the backup should be executed. Possible values are Day or Hour.

KeepAtLeastOneBackup bool

Should at least one backup always be kept in the Storage Account by the Retention Policy, regardless of how old it is?

RetentionPeriodInDays int

Specifies the number of days after which Backups should be deleted.

StartTime string

Sets when the schedule should start working.

FrequencyInterval int

Sets how often the backup should be executed.

FrequencyUnit string

Sets the unit of time for how often the backup should be executed. Possible values are Day or Hour.

KeepAtLeastOneBackup bool

Should at least one backup always be kept in the Storage Account by the Retention Policy, regardless of how old it is?

RetentionPeriodInDays int

Specifies the number of days after which Backups should be deleted.

StartTime string

Sets when the schedule should start working.

frequencyInterval Integer

Sets how often the backup should be executed.

frequencyUnit String

Sets the unit of time for how often the backup should be executed. Possible values are Day or Hour.

keepAtLeastOneBackup Boolean

Should at least one backup always be kept in the Storage Account by the Retention Policy, regardless of how old it is?

retentionPeriodInDays Integer

Specifies the number of days after which Backups should be deleted.

startTime String

Sets when the schedule should start working.

frequencyInterval number

Sets how often the backup should be executed.

frequencyUnit string

Sets the unit of time for how often the backup should be executed. Possible values are Day or Hour.

keepAtLeastOneBackup boolean

Should at least one backup always be kept in the Storage Account by the Retention Policy, regardless of how old it is?

retentionPeriodInDays number

Specifies the number of days after which Backups should be deleted.

startTime string

Sets when the schedule should start working.

frequency_interval int

Sets how often the backup should be executed.

frequency_unit str

Sets the unit of time for how often the backup should be executed. Possible values are Day or Hour.

keep_at_least_one_backup bool

Should at least one backup always be kept in the Storage Account by the Retention Policy, regardless of how old it is?

retention_period_in_days int

Specifies the number of days after which Backups should be deleted.

start_time str

Sets when the schedule should start working.

frequencyInterval Number

Sets how often the backup should be executed.

frequencyUnit String

Sets the unit of time for how often the backup should be executed. Possible values are Day or Hour.

keepAtLeastOneBackup Boolean

Should at least one backup always be kept in the Storage Account by the Retention Policy, regardless of how old it is?

retentionPeriodInDays Number

Specifies the number of days after which Backups should be deleted.

startTime String

Sets when the schedule should start working.

AppServiceConnectionString

Name string

The name of the Connection String.

Type string

The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

Value string

The value for the Connection String.

Name string

The name of the Connection String.

Type string

The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

Value string

The value for the Connection String.

name String

The name of the Connection String.

type String

The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

value String

The value for the Connection String.

name string

The name of the Connection String.

type string

The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

value string

The value for the Connection String.

name str

The name of the Connection String.

type str

The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

value str

The value for the Connection String.

name String

The name of the Connection String.

type String

The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

value String

The value for the Connection String.

AppServiceIdentity

Type string

Specifies the identity type of the App Service. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned where you can specify the Service Principal IDs in the identity_ids field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities.

IdentityIds List<string>

Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.

PrincipalId string

The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.

TenantId string

The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.

Type string

Specifies the identity type of the App Service. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned where you can specify the Service Principal IDs in the identity_ids field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities.

IdentityIds []string

Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.

PrincipalId string

The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.

TenantId string

The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.

type String

Specifies the identity type of the App Service. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned where you can specify the Service Principal IDs in the identity_ids field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities.

identityIds List<String>

Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.

principalId String

The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.

tenantId String

The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.

type string

Specifies the identity type of the App Service. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned where you can specify the Service Principal IDs in the identity_ids field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities.

identityIds string[]

Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.

principalId string

The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.

tenantId string

The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.

type str

Specifies the identity type of the App Service. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned where you can specify the Service Principal IDs in the identity_ids field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities.

identity_ids Sequence[str]

Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.

principal_id str

The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.

tenant_id str

The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.

type String

Specifies the identity type of the App Service. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned where you can specify the Service Principal IDs in the identity_ids field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities.

identityIds List<String>

Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.

principalId String

The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.

tenantId String

The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.

AppServiceLogs

ApplicationLogs AppServiceLogsApplicationLogs

An application_logs block as defined below.

DetailedErrorMessagesEnabled bool

Should Detailed error messages be enabled on this App Service? Defaults to false.

FailedRequestTracingEnabled bool

Should Failed request tracing be enabled on this App Service? Defaults to false.

HttpLogs AppServiceLogsHttpLogs

An http_logs block as defined below.

ApplicationLogs AppServiceLogsApplicationLogs

An application_logs block as defined below.

DetailedErrorMessagesEnabled bool

Should Detailed error messages be enabled on this App Service? Defaults to false.

FailedRequestTracingEnabled bool

Should Failed request tracing be enabled on this App Service? Defaults to false.

HttpLogs AppServiceLogsHttpLogs

An http_logs block as defined below.

applicationLogs AppServiceLogsApplicationLogs

An application_logs block as defined below.

detailedErrorMessagesEnabled Boolean

Should Detailed error messages be enabled on this App Service? Defaults to false.

failedRequestTracingEnabled Boolean

Should Failed request tracing be enabled on this App Service? Defaults to false.

httpLogs AppServiceLogsHttpLogs

An http_logs block as defined below.

applicationLogs AppServiceLogsApplicationLogs

An application_logs block as defined below.

detailedErrorMessagesEnabled boolean

Should Detailed error messages be enabled on this App Service? Defaults to false.

failedRequestTracingEnabled boolean

Should Failed request tracing be enabled on this App Service? Defaults to false.

httpLogs AppServiceLogsHttpLogs

An http_logs block as defined below.

application_logs AppServiceLogsApplicationLogs

An application_logs block as defined below.

detailed_error_messages_enabled bool

Should Detailed error messages be enabled on this App Service? Defaults to false.

failed_request_tracing_enabled bool

Should Failed request tracing be enabled on this App Service? Defaults to false.

http_logs AppServiceLogsHttpLogs

An http_logs block as defined below.

applicationLogs Property Map

An application_logs block as defined below.

detailedErrorMessagesEnabled Boolean

Should Detailed error messages be enabled on this App Service? Defaults to false.

failedRequestTracingEnabled Boolean

Should Failed request tracing be enabled on this App Service? Defaults to false.

httpLogs Property Map

An http_logs block as defined below.

AppServiceLogsApplicationLogs

AzureBlobStorage AppServiceLogsApplicationLogsAzureBlobStorage

An azure_blob_storage block as defined below.

FileSystemLevel string

Log level for filesystem based logging. Supported values are Error, Information, Verbose, Warning and Off. Defaults to Off.

AzureBlobStorage AppServiceLogsApplicationLogsAzureBlobStorage

An azure_blob_storage block as defined below.

FileSystemLevel string

Log level for filesystem based logging. Supported values are Error, Information, Verbose, Warning and Off. Defaults to Off.

azureBlobStorage AppServiceLogsApplicationLogsAzureBlobStorage

An azure_blob_storage block as defined below.

fileSystemLevel String

Log level for filesystem based logging. Supported values are Error, Information, Verbose, Warning and Off. Defaults to Off.

azureBlobStorage AppServiceLogsApplicationLogsAzureBlobStorage

An azure_blob_storage block as defined below.

fileSystemLevel string

Log level for filesystem based logging. Supported values are Error, Information, Verbose, Warning and Off. Defaults to Off.

azure_blob_storage AppServiceLogsApplicationLogsAzureBlobStorage

An azure_blob_storage block as defined below.

file_system_level str

Log level for filesystem based logging. Supported values are Error, Information, Verbose, Warning and Off. Defaults to Off.

azureBlobStorage Property Map

An azure_blob_storage block as defined below.

fileSystemLevel String

Log level for filesystem based logging. Supported values are Error, Information, Verbose, Warning and Off. Defaults to Off.

AppServiceLogsApplicationLogsAzureBlobStorage

Level string

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

RetentionInDays int

The number of days to retain logs for.

SasUrl string

The URL to the storage container with a shared access signature token appended.

Level string

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

RetentionInDays int

The number of days to retain logs for.

SasUrl string

The URL to the storage container with a shared access signature token appended.

level String

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

retentionInDays Integer

The number of days to retain logs for.

sasUrl String

The URL to the storage container with a shared access signature token appended.

level string

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

retentionInDays number

The number of days to retain logs for.

sasUrl string

The URL to the storage container with a shared access signature token appended.

level str

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

retention_in_days int

The number of days to retain logs for.

sas_url str

The URL to the storage container with a shared access signature token appended.

level String

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

retentionInDays Number

The number of days to retain logs for.

sasUrl String

The URL to the storage container with a shared access signature token appended.

AppServiceLogsHttpLogs

AzureBlobStorage AppServiceLogsHttpLogsAzureBlobStorage

An azure_blob_storage block as defined below.

FileSystem AppServiceLogsHttpLogsFileSystem

A file_system block as defined below.

AzureBlobStorage AppServiceLogsHttpLogsAzureBlobStorage

An azure_blob_storage block as defined below.

FileSystem AppServiceLogsHttpLogsFileSystem

A file_system block as defined below.

azureBlobStorage AppServiceLogsHttpLogsAzureBlobStorage

An azure_blob_storage block as defined below.

fileSystem AppServiceLogsHttpLogsFileSystem

A file_system block as defined below.

azureBlobStorage AppServiceLogsHttpLogsAzureBlobStorage

An azure_blob_storage block as defined below.

fileSystem AppServiceLogsHttpLogsFileSystem

A file_system block as defined below.

azure_blob_storage AppServiceLogsHttpLogsAzureBlobStorage

An azure_blob_storage block as defined below.

file_system AppServiceLogsHttpLogsFileSystem

A file_system block as defined below.

azureBlobStorage Property Map

An azure_blob_storage block as defined below.

fileSystem Property Map

A file_system block as defined below.

AppServiceLogsHttpLogsAzureBlobStorage

RetentionInDays int

The number of days to retain logs for.

SasUrl string

The URL to the storage container with a shared access signature token appended.

RetentionInDays int

The number of days to retain logs for.

SasUrl string

The URL to the storage container with a shared access signature token appended.

retentionInDays Integer

The number of days to retain logs for.

sasUrl String

The URL to the storage container with a shared access signature token appended.

retentionInDays number

The number of days to retain logs for.

sasUrl string

The URL to the storage container with a shared access signature token appended.

retention_in_days int

The number of days to retain logs for.

sas_url str

The URL to the storage container with a shared access signature token appended.

retentionInDays Number

The number of days to retain logs for.

sasUrl String

The URL to the storage container with a shared access signature token appended.

AppServiceLogsHttpLogsFileSystem

RetentionInDays int

The number of days to retain logs for.

RetentionInMb int

The maximum size in megabytes that HTTP log files can use before being removed.

RetentionInDays int

The number of days to retain logs for.

RetentionInMb int

The maximum size in megabytes that HTTP log files can use before being removed.

retentionInDays Integer

The number of days to retain logs for.

retentionInMb Integer

The maximum size in megabytes that HTTP log files can use before being removed.

retentionInDays number

The number of days to retain logs for.

retentionInMb number

The maximum size in megabytes that HTTP log files can use before being removed.

retention_in_days int

The number of days to retain logs for.

retention_in_mb int

The maximum size in megabytes that HTTP log files can use before being removed.

retentionInDays Number

The number of days to retain logs for.

retentionInMb Number

The maximum size in megabytes that HTTP log files can use before being removed.

AppServiceSiteConfig

AcrUseManagedIdentityCredentials bool

Are Managed Identity Credentials used for Azure Container Registry pull

AcrUserManagedIdentityClientId string

If using User Managed Identity, the User Managed Identity Client Id

AlwaysOn bool

Should the app be loaded at all times? Defaults to false.

AppCommandLine string

App command line to launch, e.g. /sbin/myserver -b 0.0.0.0.

AutoSwapSlotName string
Cors AppServiceSiteConfigCors

A cors block as defined below.

DefaultDocuments List<string>

The ordering of default documents to load, if an address isn't specified.

DotnetFrameworkVersion string

The version of the .NET framework's CLR used in this App Service. Possible values are v2.0 (which will use the latest version of the .NET framework for the .NET CLR v2 - currently .net 3.5), v4.0 (which corresponds to the latest version of the .NET CLR v4 - which at the time of writing is .net 4.7.1), v5.0 and v6.0. For more information on which .NET CLR version to use based on the .NET framework you're targeting - please see this table. Defaults to v4.0.

FtpsState string

State of FTP / FTPS service for this App Service. Possible values include: AllAllowed, FtpsOnly and Disabled.

HealthCheckPath string

The health check path to be pinged by App Service. For more information - please see App Service health check announcement.

Http2Enabled bool

Is HTTP2 Enabled on this App Service? Defaults to false.

IpRestrictions List<AppServiceSiteConfigIpRestriction>

A list of objects representing ip restrictions as defined below.

JavaContainer string

The Java Container to use. If specified java_version and java_container_version must also be specified. Possible values are JAVA, JETTY, and TOMCAT.

JavaContainerVersion string

The version of the Java Container to use. If specified java_version and java_container must also be specified.

JavaVersion string

The version of Java to use. If specified java_container and java_container_version must also be specified. Possible values are 1.7, 1.8 and 11 and their specific versions - except for Java 11 (e.g. 1.7.0_80, 1.8.0_181, 11)

LinuxFxVersion string

Linux App Framework and version for the App Service. Possible options are a Docker container (DOCKER|<user/image:tag>), a base-64 encoded Docker Compose file (COMPOSE|${filebase64("compose.yml")}) or a base-64 encoded Kubernetes Manifest (KUBE|${filebase64("kubernetes.yml")}).

LocalMysqlEnabled bool

Is "MySQL In App" Enabled? This runs a local MySQL instance with your app and shares resources from the App Service plan.

ManagedPipelineMode string

The Managed Pipeline Mode. Possible values are Integrated and Classic. Defaults to Integrated.

MinTlsVersion string

The minimum supported TLS version for the app service. Possible values are 1.0, 1.1, and 1.2. Defaults to 1.2 for new app services.

NumberOfWorkers int

The scaled number of workers (for per site scaling) of this App Service. Requires that per_site_scaling is enabled on the azure.appservice.Plan. For more information - please see Microsoft documentation on high-density hosting.

PhpVersion string

The version of PHP to use in this App Service. Possible values are 5.5, 5.6, 7.0, 7.1, 7.2, 7.3 and 7.4.

PythonVersion string

The version of Python to use in this App Service. Possible values are 2.7 and 3.4.

RemoteDebuggingEnabled bool

Is Remote Debugging Enabled? Defaults to false.

RemoteDebuggingVersion string

Which version of Visual Studio should the Remote Debugger be compatible with? Possible values are VS2012, VS2013, VS2015 and VS2017.

ScmIpRestrictions List<AppServiceSiteConfigScmIpRestriction>

A List of objects representing IP restrictions as defined below.

ScmType string

The type of Source Control enabled for this App Service. Defaults to None. Possible values are: BitbucketGit, BitbucketHg, CodePlexGit, CodePlexHg, Dropbox, ExternalGit, ExternalHg, GitHub, LocalGit, None, OneDrive, Tfs, VSO, and VSTSRM

ScmUseMainIpRestriction bool

IP security restrictions for scm to use main. Defaults to false.

Use32BitWorkerProcess bool

Should the App Service run in 32 bit mode, rather than 64 bit mode?

VnetRouteAllEnabled bool

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

WebsocketsEnabled bool

Should WebSockets be enabled?

WindowsFxVersion string

The Windows Docker container image (DOCKER|<user/image:tag>)

AcrUseManagedIdentityCredentials bool

Are Managed Identity Credentials used for Azure Container Registry pull

AcrUserManagedIdentityClientId string

If using User Managed Identity, the User Managed Identity Client Id

AlwaysOn bool

Should the app be loaded at all times? Defaults to false.

AppCommandLine string

App command line to launch, e.g. /sbin/myserver -b 0.0.0.0.

AutoSwapSlotName string
Cors AppServiceSiteConfigCors

A cors block as defined below.

DefaultDocuments []string

The ordering of default documents to load, if an address isn't specified.

DotnetFrameworkVersion string

The version of the .NET framework's CLR used in this App Service. Possible values are v2.0 (which will use the latest version of the .NET framework for the .NET CLR v2 - currently .net 3.5), v4.0 (which corresponds to the latest version of the .NET CLR v4 - which at the time of writing is .net 4.7.1), v5.0 and v6.0. For more information on which .NET CLR version to use based on the .NET framework you're targeting - please see this table. Defaults to v4.0.

FtpsState string

State of FTP / FTPS service for this App Service. Possible values include: AllAllowed, FtpsOnly and Disabled.

HealthCheckPath string

The health check path to be pinged by App Service. For more information - please see App Service health check announcement.

Http2Enabled bool

Is HTTP2 Enabled on this App Service? Defaults to false.

IpRestrictions []AppServiceSiteConfigIpRestriction

A list of objects representing ip restrictions as defined below.

JavaContainer string

The Java Container to use. If specified java_version and java_container_version must also be specified. Possible values are JAVA, JETTY, and TOMCAT.

JavaContainerVersion string

The version of the Java Container to use. If specified java_version and java_container must also be specified.

JavaVersion string

The version of Java to use. If specified java_container and java_container_version must also be specified. Possible values are 1.7, 1.8 and 11 and their specific versions - except for Java 11 (e.g. 1.7.0_80, 1.8.0_181, 11)

LinuxFxVersion string

Linux App Framework and version for the App Service. Possible options are a Docker container (DOCKER|<user/image:tag>), a base-64 encoded Docker Compose file (COMPOSE|${filebase64("compose.yml")}) or a base-64 encoded Kubernetes Manifest (KUBE|${filebase64("kubernetes.yml")}).

LocalMysqlEnabled bool

Is "MySQL In App" Enabled? This runs a local MySQL instance with your app and shares resources from the App Service plan.

ManagedPipelineMode string

The Managed Pipeline Mode. Possible values are Integrated and Classic. Defaults to Integrated.

MinTlsVersion string

The minimum supported TLS version for the app service. Possible values are 1.0, 1.1, and 1.2. Defaults to 1.2 for new app services.

NumberOfWorkers int

The scaled number of workers (for per site scaling) of this App Service. Requires that per_site_scaling is enabled on the azure.appservice.Plan. For more information - please see Microsoft documentation on high-density hosting.

PhpVersion string

The version of PHP to use in this App Service. Possible values are 5.5, 5.6, 7.0, 7.1, 7.2, 7.3 and 7.4.

PythonVersion string

The version of Python to use in this App Service. Possible values are 2.7 and 3.4.

RemoteDebuggingEnabled bool

Is Remote Debugging Enabled? Defaults to false.

RemoteDebuggingVersion string

Which version of Visual Studio should the Remote Debugger be compatible with? Possible values are VS2012, VS2013, VS2015 and VS2017.

ScmIpRestrictions []AppServiceSiteConfigScmIpRestriction

A List of objects representing IP restrictions as defined below.

ScmType string

The type of Source Control enabled for this App Service. Defaults to None. Possible values are: BitbucketGit, BitbucketHg, CodePlexGit, CodePlexHg, Dropbox, ExternalGit, ExternalHg, GitHub, LocalGit, None, OneDrive, Tfs, VSO, and VSTSRM

ScmUseMainIpRestriction bool

IP security restrictions for scm to use main. Defaults to false.

Use32BitWorkerProcess bool

Should the App Service run in 32 bit mode, rather than 64 bit mode?

VnetRouteAllEnabled bool

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

WebsocketsEnabled bool

Should WebSockets be enabled?

WindowsFxVersion string

The Windows Docker container image (DOCKER|<user/image:tag>)

acrUseManagedIdentityCredentials Boolean

Are Managed Identity Credentials used for Azure Container Registry pull

acrUserManagedIdentityClientId String

If using User Managed Identity, the User Managed Identity Client Id

alwaysOn Boolean

Should the app be loaded at all times? Defaults to false.

appCommandLine String

App command line to launch, e.g. /sbin/myserver -b 0.0.0.0.

autoSwapSlotName String
cors AppServiceSiteConfigCors

A cors block as defined below.

defaultDocuments List<String>

The ordering of default documents to load, if an address isn't specified.

dotnetFrameworkVersion String

The version of the .NET framework's CLR used in this App Service. Possible values are v2.0 (which will use the latest version of the .NET framework for the .NET CLR v2 - currently .net 3.5), v4.0 (which corresponds to the latest version of the .NET CLR v4 - which at the time of writing is .net 4.7.1), v5.0 and v6.0. For more information on which .NET CLR version to use based on the .NET framework you're targeting - please see this table. Defaults to v4.0.

ftpsState String

State of FTP / FTPS service for this App Service. Possible values include: AllAllowed, FtpsOnly and Disabled.

healthCheckPath String

The health check path to be pinged by App Service. For more information - please see App Service health check announcement.

http2Enabled Boolean

Is HTTP2 Enabled on this App Service? Defaults to false.

ipRestrictions List<AppServiceSiteConfigIpRestriction>

A list of objects representing ip restrictions as defined below.

javaContainer String

The Java Container to use. If specified java_version and java_container_version must also be specified. Possible values are JAVA, JETTY, and TOMCAT.

javaContainerVersion String

The version of the Java Container to use. If specified java_version and java_container must also be specified.

javaVersion String

The version of Java to use. If specified java_container and java_container_version must also be specified. Possible values are 1.7, 1.8 and 11 and their specific versions - except for Java 11 (e.g. 1.7.0_80, 1.8.0_181, 11)

linuxFxVersion String

Linux App Framework and version for the App Service. Possible options are a Docker container (DOCKER|<user/image:tag>), a base-64 encoded Docker Compose file (COMPOSE|${filebase64("compose.yml")}) or a base-64 encoded Kubernetes Manifest (KUBE|${filebase64("kubernetes.yml")}).

localMysqlEnabled Boolean

Is "MySQL In App" Enabled? This runs a local MySQL instance with your app and shares resources from the App Service plan.

managedPipelineMode String

The Managed Pipeline Mode. Possible values are Integrated and Classic. Defaults to Integrated.

minTlsVersion String

The minimum supported TLS version for the app service. Possible values are 1.0, 1.1, and 1.2. Defaults to 1.2 for new app services.

numberOfWorkers Integer

The scaled number of workers (for per site scaling) of this App Service. Requires that per_site_scaling is enabled on the azure.appservice.Plan. For more information - please see Microsoft documentation on high-density hosting.

phpVersion String

The version of PHP to use in this App Service. Possible values are 5.5, 5.6, 7.0, 7.1, 7.2, 7.3 and 7.4.

pythonVersion String

The version of Python to use in this App Service. Possible values are 2.7 and 3.4.

remoteDebuggingEnabled Boolean

Is Remote Debugging Enabled? Defaults to false.

remoteDebuggingVersion String

Which version of Visual Studio should the Remote Debugger be compatible with? Possible values are VS2012, VS2013, VS2015 and VS2017.

scmIpRestrictions List<AppServiceSiteConfigScmIpRestriction>

A List of objects representing IP restrictions as defined below.

scmType String

The type of Source Control enabled for this App Service. Defaults to None. Possible values are: BitbucketGit, BitbucketHg, CodePlexGit, CodePlexHg, Dropbox, ExternalGit, ExternalHg, GitHub, LocalGit, None, OneDrive, Tfs, VSO, and VSTSRM

scmUseMainIpRestriction Boolean

IP security restrictions for scm to use main. Defaults to false.

use32BitWorkerProcess Boolean

Should the App Service run in 32 bit mode, rather than 64 bit mode?

vnetRouteAllEnabled Boolean

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

websocketsEnabled Boolean

Should WebSockets be enabled?

windowsFxVersion String

The Windows Docker container image (DOCKER|<user/image:tag>)

acrUseManagedIdentityCredentials boolean

Are Managed Identity Credentials used for Azure Container Registry pull

acrUserManagedIdentityClientId string

If using User Managed Identity, the User Managed Identity Client Id

alwaysOn boolean

Should the app be loaded at all times? Defaults to false.

appCommandLine string

App command line to launch, e.g. /sbin/myserver -b 0.0.0.0.

autoSwapSlotName string
cors AppServiceSiteConfigCors

A cors block as defined below.

defaultDocuments string[]

The ordering of default documents to load, if an address isn't specified.

dotnetFrameworkVersion string

The version of the .NET framework's CLR used in this App Service. Possible values are v2.0 (which will use the latest version of the .NET framework for the .NET CLR v2 - currently .net 3.5), v4.0 (which corresponds to the latest version of the .NET CLR v4 - which at the time of writing is .net 4.7.1), v5.0 and v6.0. For more information on which .NET CLR version to use based on the .NET framework you're targeting - please see this table. Defaults to v4.0.

ftpsState string

State of FTP / FTPS service for this App Service. Possible values include: AllAllowed, FtpsOnly and Disabled.

healthCheckPath string

The health check path to be pinged by App Service. For more information - please see App Service health check announcement.

http2Enabled boolean

Is HTTP2 Enabled on this App Service? Defaults to false.

ipRestrictions AppServiceSiteConfigIpRestriction[]

A list of objects representing ip restrictions as defined below.

javaContainer string

The Java Container to use. If specified java_version and java_container_version must also be specified. Possible values are JAVA, JETTY, and TOMCAT.

javaContainerVersion string

The version of the Java Container to use. If specified java_version and java_container must also be specified.

javaVersion string

The version of Java to use. If specified java_container and java_container_version must also be specified. Possible values are 1.7, 1.8 and 11 and their specific versions - except for Java 11 (e.g. 1.7.0_80, 1.8.0_181, 11)

linuxFxVersion string

Linux App Framework and version for the App Service. Possible options are a Docker container (DOCKER|<user/image:tag>), a base-64 encoded Docker Compose file (COMPOSE|${filebase64("compose.yml")}) or a base-64 encoded Kubernetes Manifest (KUBE|${filebase64("kubernetes.yml")}).

localMysqlEnabled boolean

Is "MySQL In App" Enabled? This runs a local MySQL instance with your app and shares resources from the App Service plan.

managedPipelineMode string

The Managed Pipeline Mode. Possible values are Integrated and Classic. Defaults to Integrated.

minTlsVersion string

The minimum supported TLS version for the app service. Possible values are 1.0, 1.1, and 1.2. Defaults to 1.2 for new app services.

numberOfWorkers number

The scaled number of workers (for per site scaling) of this App Service. Requires that per_site_scaling is enabled on the azure.appservice.Plan. For more information - please see Microsoft documentation on high-density hosting.

phpVersion string

The version of PHP to use in this App Service. Possible values are 5.5, 5.6, 7.0, 7.1, 7.2, 7.3 and 7.4.

pythonVersion string

The version of Python to use in this App Service. Possible values are 2.7 and 3.4.

remoteDebuggingEnabled boolean

Is Remote Debugging Enabled? Defaults to false.

remoteDebuggingVersion string

Which version of Visual Studio should the Remote Debugger be compatible with? Possible values are VS2012, VS2013, VS2015 and VS2017.

scmIpRestrictions AppServiceSiteConfigScmIpRestriction[]

A List of objects representing IP restrictions as defined below.

scmType string

The type of Source Control enabled for this App Service. Defaults to None. Possible values are: BitbucketGit, BitbucketHg, CodePlexGit, CodePlexHg, Dropbox, ExternalGit, ExternalHg, GitHub, LocalGit, None, OneDrive, Tfs, VSO, and VSTSRM

scmUseMainIpRestriction boolean

IP security restrictions for scm to use main. Defaults to false.

use32BitWorkerProcess boolean

Should the App Service run in 32 bit mode, rather than 64 bit mode?

vnetRouteAllEnabled boolean

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

websocketsEnabled boolean

Should WebSockets be enabled?

windowsFxVersion string

The Windows Docker container image (DOCKER|<user/image:tag>)

acr_use_managed_identity_credentials bool

Are Managed Identity Credentials used for Azure Container Registry pull

acr_user_managed_identity_client_id str

If using User Managed Identity, the User Managed Identity Client Id

always_on bool

Should the app be loaded at all times? Defaults to false.

app_command_line str

App command line to launch, e.g. /sbin/myserver -b 0.0.0.0.

auto_swap_slot_name str
cors AppServiceSiteConfigCors

A cors block as defined below.

default_documents Sequence[str]

The ordering of default documents to load, if an address isn't specified.

dotnet_framework_version str

The version of the .NET framework's CLR used in this App Service. Possible values are v2.0 (which will use the latest version of the .NET framework for the .NET CLR v2 - currently .net 3.5), v4.0 (which corresponds to the latest version of the .NET CLR v4 - which at the time of writing is .net 4.7.1), v5.0 and v6.0. For more information on which .NET CLR version to use based on the .NET framework you're targeting - please see this table. Defaults to v4.0.

ftps_state str

State of FTP / FTPS service for this App Service. Possible values include: AllAllowed, FtpsOnly and Disabled.

health_check_path str

The health check path to be pinged by App Service. For more information - please see App Service health check announcement.

http2_enabled bool

Is HTTP2 Enabled on this App Service? Defaults to false.

ip_restrictions Sequence[AppServiceSiteConfigIpRestriction]

A list of objects representing ip restrictions as defined below.

java_container str

The Java Container to use. If specified java_version and java_container_version must also be specified. Possible values are JAVA, JETTY, and TOMCAT.

java_container_version str

The version of the Java Container to use. If specified java_version and java_container must also be specified.

java_version str

The version of Java to use. If specified java_container and java_container_version must also be specified. Possible values are 1.7, 1.8 and 11 and their specific versions - except for Java 11 (e.g. 1.7.0_80, 1.8.0_181, 11)

linux_fx_version str

Linux App Framework and version for the App Service. Possible options are a Docker container (DOCKER|<user/image:tag>), a base-64 encoded Docker Compose file (COMPOSE|${filebase64("compose.yml")}) or a base-64 encoded Kubernetes Manifest (KUBE|${filebase64("kubernetes.yml")}).

local_mysql_enabled bool

Is "MySQL In App" Enabled? This runs a local MySQL instance with your app and shares resources from the App Service plan.

managed_pipeline_mode str

The Managed Pipeline Mode. Possible values are Integrated and Classic. Defaults to Integrated.

min_tls_version str

The minimum supported TLS version for the app service. Possible values are 1.0, 1.1, and 1.2. Defaults to 1.2 for new app services.

number_of_workers int

The scaled number of workers (for per site scaling) of this App Service. Requires that per_site_scaling is enabled on the azure.appservice.Plan. For more information - please see Microsoft documentation on high-density hosting.

php_version str

The version of PHP to use in this App Service. Possible values are 5.5, 5.6, 7.0, 7.1, 7.2, 7.3 and 7.4.

python_version str

The version of Python to use in this App Service. Possible values are 2.7 and 3.4.

remote_debugging_enabled bool

Is Remote Debugging Enabled? Defaults to false.

remote_debugging_version str

Which version of Visual Studio should the Remote Debugger be compatible with? Possible values are VS2012, VS2013, VS2015 and VS2017.

scm_ip_restrictions Sequence[AppServiceSiteConfigScmIpRestriction]

A List of objects representing IP restrictions as defined below.

scm_type str

The type of Source Control enabled for this App Service. Defaults to None. Possible values are: BitbucketGit, BitbucketHg, CodePlexGit, CodePlexHg, Dropbox, ExternalGit, ExternalHg, GitHub, LocalGit, None, OneDrive, Tfs, VSO, and VSTSRM

scm_use_main_ip_restriction bool

IP security restrictions for scm to use main. Defaults to false.

use32_bit_worker_process bool

Should the App Service run in 32 bit mode, rather than 64 bit mode?

vnet_route_all_enabled bool

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

websockets_enabled bool

Should WebSockets be enabled?

windows_fx_version str

The Windows Docker container image (DOCKER|<user/image:tag>)

acrUseManagedIdentityCredentials Boolean

Are Managed Identity Credentials used for Azure Container Registry pull

acrUserManagedIdentityClientId String

If using User Managed Identity, the User Managed Identity Client Id

alwaysOn Boolean

Should the app be loaded at all times? Defaults to false.

appCommandLine String

App command line to launch, e.g. /sbin/myserver -b 0.0.0.0.

autoSwapSlotName String
cors Property Map

A cors block as defined below.

defaultDocuments List<String>

The ordering of default documents to load, if an address isn't specified.

dotnetFrameworkVersion String

The version of the .NET framework's CLR used in this App Service. Possible values are v2.0 (which will use the latest version of the .NET framework for the .NET CLR v2 - currently .net 3.5), v4.0 (which corresponds to the latest version of the .NET CLR v4 - which at the time of writing is .net 4.7.1), v5.0 and v6.0. For more information on which .NET CLR version to use based on the .NET framework you're targeting - please see this table. Defaults to v4.0.

ftpsState String

State of FTP / FTPS service for this App Service. Possible values include: AllAllowed, FtpsOnly and Disabled.

healthCheckPath String

The health check path to be pinged by App Service. For more information - please see App Service health check announcement.

http2Enabled Boolean

Is HTTP2 Enabled on this App Service? Defaults to false.

ipRestrictions List<Property Map>

A list of objects representing ip restrictions as defined below.

javaContainer String

The Java Container to use. If specified java_version and java_container_version must also be specified. Possible values are JAVA, JETTY, and TOMCAT.

javaContainerVersion String

The version of the Java Container to use. If specified java_version and java_container must also be specified.

javaVersion String

The version of Java to use. If specified java_container and java_container_version must also be specified. Possible values are 1.7, 1.8 and 11 and their specific versions - except for Java 11 (e.g. 1.7.0_80, 1.8.0_181, 11)

linuxFxVersion String

Linux App Framework and version for the App Service. Possible options are a Docker container (DOCKER|<user/image:tag>), a base-64 encoded Docker Compose file (COMPOSE|${filebase64("compose.yml")}) or a base-64 encoded Kubernetes Manifest (KUBE|${filebase64("kubernetes.yml")}).

localMysqlEnabled Boolean

Is "MySQL In App" Enabled? This runs a local MySQL instance with your app and shares resources from the App Service plan.

managedPipelineMode String

The Managed Pipeline Mode. Possible values are Integrated and Classic. Defaults to Integrated.

minTlsVersion String

The minimum supported TLS version for the app service. Possible values are 1.0, 1.1, and 1.2. Defaults to 1.2 for new app services.

numberOfWorkers Number

The scaled number of workers (for per site scaling) of this App Service. Requires that per_site_scaling is enabled on the azure.appservice.Plan. For more information - please see Microsoft documentation on high-density hosting.

phpVersion String

The version of PHP to use in this App Service. Possible values are 5.5, 5.6, 7.0, 7.1, 7.2, 7.3 and 7.4.

pythonVersion String

The version of Python to use in this App Service. Possible values are 2.7 and 3.4.

remoteDebuggingEnabled Boolean

Is Remote Debugging Enabled? Defaults to false.

remoteDebuggingVersion String

Which version of Visual Studio should the Remote Debugger be compatible with? Possible values are VS2012, VS2013, VS2015 and VS2017.

scmIpRestrictions List<Property Map>

A List of objects representing IP restrictions as defined below.

scmType String

The type of Source Control enabled for this App Service. Defaults to None. Possible values are: BitbucketGit, BitbucketHg, CodePlexGit, CodePlexHg, Dropbox, ExternalGit, ExternalHg, GitHub, LocalGit, None, OneDrive, Tfs, VSO, and VSTSRM

scmUseMainIpRestriction Boolean

IP security restrictions for scm to use main. Defaults to false.

use32BitWorkerProcess Boolean

Should the App Service run in 32 bit mode, rather than 64 bit mode?

vnetRouteAllEnabled Boolean

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

websocketsEnabled Boolean

Should WebSockets be enabled?

windowsFxVersion String

The Windows Docker container image (DOCKER|<user/image:tag>)

AppServiceSiteConfigCors

AllowedOrigins List<string>

A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.

SupportCredentials bool

Are credentials supported?

AllowedOrigins []string

A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.

SupportCredentials bool

Are credentials supported?

allowedOrigins List<String>

A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.

supportCredentials Boolean

Are credentials supported?

allowedOrigins string[]

A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.

supportCredentials boolean

Are credentials supported?

allowed_origins Sequence[str]

A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.

support_credentials bool

Are credentials supported?

allowedOrigins List<String>

A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.

supportCredentials Boolean

Are credentials supported?

AppServiceSiteConfigIpRestriction

Action string

Does this restriction Allow or Deny access for this IP range. Defaults to Allow.

Headers AppServiceSiteConfigIpRestrictionHeaders

The headers for this specific ip_restriction as defined below.

IpAddress string

The IP Address used for this IP Restriction in CIDR notation.

Name string

The name for this IP Restriction.

Priority int

The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified.

ServiceTag string

The Service Tag used for this IP Restriction.

VirtualNetworkSubnetId string

The Virtual Network Subnet ID used for this IP Restriction.

Action string

Does this restriction Allow or Deny access for this IP range. Defaults to Allow.

Headers AppServiceSiteConfigIpRestrictionHeaders

The headers for this specific ip_restriction as defined below.

IpAddress string

The IP Address used for this IP Restriction in CIDR notation.

Name string

The name for this IP Restriction.

Priority int

The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified.

ServiceTag string

The Service Tag used for this IP Restriction.

VirtualNetworkSubnetId string

The Virtual Network Subnet ID used for this IP Restriction.

action String

Does this restriction Allow or Deny access for this IP range. Defaults to Allow.

headers AppServiceSiteConfigIpRestrictionHeaders

The headers for this specific ip_restriction as defined below.

ipAddress String

The IP Address used for this IP Restriction in CIDR notation.

name String

The name for this IP Restriction.

priority Integer

The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified.

serviceTag String

The Service Tag used for this IP Restriction.

virtualNetworkSubnetId String

The Virtual Network Subnet ID used for this IP Restriction.

action string

Does this restriction Allow or Deny access for this IP range. Defaults to Allow.

headers AppServiceSiteConfigIpRestrictionHeaders

The headers for this specific ip_restriction as defined below.

ipAddress string

The IP Address used for this IP Restriction in CIDR notation.

name string

The name for this IP Restriction.

priority number

The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified.

serviceTag string

The Service Tag used for this IP Restriction.

virtualNetworkSubnetId string

The Virtual Network Subnet ID used for this IP Restriction.

action str

Does this restriction Allow or Deny access for this IP range. Defaults to Allow.

headers AppServiceSiteConfigIpRestrictionHeaders

The headers for this specific ip_restriction as defined below.

ip_address str

The IP Address used for this IP Restriction in CIDR notation.

name str

The name for this IP Restriction.

priority int

The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified.

service_tag str

The Service Tag used for this IP Restriction.

virtual_network_subnet_id str

The Virtual Network Subnet ID used for this IP Restriction.

action String

Does this restriction Allow or Deny access for this IP range. Defaults to Allow.

headers Property Map

The headers for this specific ip_restriction as defined below.

ipAddress String

The IP Address used for this IP Restriction in CIDR notation.

name String

The name for this IP Restriction.

priority Number

The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified.

serviceTag String

The Service Tag used for this IP Restriction.

virtualNetworkSubnetId String

The Virtual Network Subnet ID used for this IP Restriction.

AppServiceSiteConfigIpRestrictionHeaders

XAzureFdids List<string>

A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.

XFdHealthProbe string

A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".

XForwardedFors List<string>

A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8

XForwardedHosts List<string>

A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.

XAzureFdids []string

A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.

XFdHealthProbe string

A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".

XForwardedFors []string

A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8

XForwardedHosts []string

A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.

xAzureFdids List<String>

A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.

xFdHealthProbe String

A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".

xForwardedFors List<String>

A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8

xForwardedHosts List<String>

A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.

xAzureFdids string[]

A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.

xFdHealthProbe string

A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".

xForwardedFors string[]

A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8

xForwardedHosts string[]

A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.

x_azure_fdids Sequence[str]

A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.

x_fd_health_probe str

A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".

x_forwarded_fors Sequence[str]

A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8

x_forwarded_hosts Sequence[str]

A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.

xAzureFdids List<String>

A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.

xFdHealthProbe String

A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".

xForwardedFors List<String>

A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8

xForwardedHosts List<String>

A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.

AppServiceSiteConfigScmIpRestriction

Action string

Allow or Deny access for this IP range. Defaults to Allow.

Headers AppServiceSiteConfigScmIpRestrictionHeaders

The headers for this specific scm_ip_restriction as defined below.

IpAddress string

The IP Address used for this IP Restriction in CIDR notation.

Name string

The name for this IP Restriction.

Priority int

The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified.

ServiceTag string

The Service Tag used for this IP Restriction.

VirtualNetworkSubnetId string

The Virtual Network Subnet ID used for this IP Restriction.

Action string

Allow or Deny access for this IP range. Defaults to Allow.

Headers AppServiceSiteConfigScmIpRestrictionHeaders

The headers for this specific scm_ip_restriction as defined below.

IpAddress string

The IP Address used for this IP Restriction in CIDR notation.

Name string

The name for this IP Restriction.

Priority int

The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified.

ServiceTag string

The Service Tag used for this IP Restriction.

VirtualNetworkSubnetId string

The Virtual Network Subnet ID used for this IP Restriction.

action String

Allow or Deny access for this IP range. Defaults to Allow.

headers AppServiceSiteConfigScmIpRestrictionHeaders

The headers for this specific scm_ip_restriction as defined below.

ipAddress String

The IP Address used for this IP Restriction in CIDR notation.

name String

The name for this IP Restriction.

priority Integer

The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified.

serviceTag String

The Service Tag used for this IP Restriction.

virtualNetworkSubnetId String

The Virtual Network Subnet ID used for this IP Restriction.

action string

Allow or Deny access for this IP range. Defaults to Allow.

headers AppServiceSiteConfigScmIpRestrictionHeaders

The headers for this specific scm_ip_restriction as defined below.

ipAddress string

The IP Address used for this IP Restriction in CIDR notation.

name string

The name for this IP Restriction.

priority number

The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified.

serviceTag string

The Service Tag used for this IP Restriction.

virtualNetworkSubnetId string

The Virtual Network Subnet ID used for this IP Restriction.

action str

Allow or Deny access for this IP range. Defaults to Allow.

headers AppServiceSiteConfigScmIpRestrictionHeaders

The headers for this specific scm_ip_restriction as defined below.

ip_address str

The IP Address used for this IP Restriction in CIDR notation.

name str

The name for this IP Restriction.

priority int

The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified.

service_tag str

The Service Tag used for this IP Restriction.

virtual_network_subnet_id str

The Virtual Network Subnet ID used for this IP Restriction.

action String

Allow or Deny access for this IP range. Defaults to Allow.

headers Property Map

The headers for this specific scm_ip_restriction as defined below.

ipAddress String

The IP Address used for this IP Restriction in CIDR notation.

name String

The name for this IP Restriction.

priority Number

The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified.

serviceTag String

The Service Tag used for this IP Restriction.

virtualNetworkSubnetId String

The Virtual Network Subnet ID used for this IP Restriction.

AppServiceSiteConfigScmIpRestrictionHeaders

XAzureFdids List<string>

A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.

XFdHealthProbe string

A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".

XForwardedFors List<string>

A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8

XForwardedHosts List<string>

A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.

XAzureFdids []string

A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.

XFdHealthProbe string

A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".

XForwardedFors []string

A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8

XForwardedHosts []string

A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.

xAzureFdids List<String>

A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.

xFdHealthProbe String

A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".

xForwardedFors List<String>

A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8

xForwardedHosts List<String>

A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.

xAzureFdids string[]

A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.

xFdHealthProbe string

A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".

xForwardedFors string[]

A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8

xForwardedHosts string[]

A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.

x_azure_fdids Sequence[str]

A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.

x_fd_health_probe str

A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".

x_forwarded_fors Sequence[str]

A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8

x_forwarded_hosts Sequence[str]

A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.

xAzureFdids List<String>

A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.

xFdHealthProbe String

A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".

xForwardedFors List<String>

A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8

xForwardedHosts List<String>

A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.

AppServiceSiteCredential

Password string

The password associated with the username, which can be used to publish to this App Service.

Username string

The username which can be used to publish to this App Service

Password string

The password associated with the username, which can be used to publish to this App Service.

Username string

The username which can be used to publish to this App Service

password String

The password associated with the username, which can be used to publish to this App Service.

username String

The username which can be used to publish to this App Service

password string

The password associated with the username, which can be used to publish to this App Service.

username string

The username which can be used to publish to this App Service

password str

The password associated with the username, which can be used to publish to this App Service.

username str

The username which can be used to publish to this App Service

password String

The password associated with the username, which can be used to publish to this App Service.

username String

The username which can be used to publish to this App Service

AppServiceSourceControl

Branch string

The branch of the remote repository to use. Defaults to 'master'.

ManualIntegration bool

Limits to manual integration. Defaults to false if not specified.

RepoUrl string

The URL of the source code repository.

RollbackEnabled bool

Enable roll-back for the repository. Defaults to false if not specified.

UseMercurial bool

Use Mercurial if true, otherwise uses Git.

Branch string

The branch of the remote repository to use. Defaults to 'master'.

ManualIntegration bool

Limits to manual integration. Defaults to false if not specified.

RepoUrl string

The URL of the source code repository.

RollbackEnabled bool

Enable roll-back for the repository. Defaults to false if not specified.

UseMercurial bool

Use Mercurial if true, otherwise uses Git.

branch String

The branch of the remote repository to use. Defaults to 'master'.

manualIntegration Boolean

Limits to manual integration. Defaults to false if not specified.

repoUrl String

The URL of the source code repository.

rollbackEnabled Boolean

Enable roll-back for the repository. Defaults to false if not specified.

useMercurial Boolean

Use Mercurial if true, otherwise uses Git.

branch string

The branch of the remote repository to use. Defaults to 'master'.

manualIntegration boolean

Limits to manual integration. Defaults to false if not specified.

repoUrl string

The URL of the source code repository.

rollbackEnabled boolean

Enable roll-back for the repository. Defaults to false if not specified.

useMercurial boolean

Use Mercurial if true, otherwise uses Git.

branch str

The branch of the remote repository to use. Defaults to 'master'.

manual_integration bool

Limits to manual integration. Defaults to false if not specified.

repo_url str

The URL of the source code repository.

rollback_enabled bool

Enable roll-back for the repository. Defaults to false if not specified.

use_mercurial bool

Use Mercurial if true, otherwise uses Git.

branch String

The branch of the remote repository to use. Defaults to 'master'.

manualIntegration Boolean

Limits to manual integration. Defaults to false if not specified.

repoUrl String

The URL of the source code repository.

rollbackEnabled Boolean

Enable roll-back for the repository. Defaults to false if not specified.

useMercurial Boolean

Use Mercurial if true, otherwise uses Git.

AppServiceStorageAccount

AccessKey string

The access key for the storage account.

AccountName string

The name of the storage account.

Name string

The name of the storage account identifier.

ShareName string

The name of the file share (container name, for Blob storage).

Type string

The type of storage. Possible values are AzureBlob and AzureFiles.

MountPath string

The path to mount the storage within the site's runtime environment.

AccessKey string

The access key for the storage account.

AccountName string

The name of the storage account.

Name string

The name of the storage account identifier.

ShareName string

The name of the file share (container name, for Blob storage).

Type string

The type of storage. Possible values are AzureBlob and AzureFiles.

MountPath string

The path to mount the storage within the site's runtime environment.

accessKey String

The access key for the storage account.

accountName String

The name of the storage account.

name String

The name of the storage account identifier.

shareName String

The name of the file share (container name, for Blob storage).

type String

The type of storage. Possible values are AzureBlob and AzureFiles.

mountPath String

The path to mount the storage within the site's runtime environment.

accessKey string

The access key for the storage account.

accountName string

The name of the storage account.

name string

The name of the storage account identifier.

shareName string

The name of the file share (container name, for Blob storage).

type string

The type of storage. Possible values are AzureBlob and AzureFiles.

mountPath string

The path to mount the storage within the site's runtime environment.

access_key str

The access key for the storage account.

account_name str

The name of the storage account.

name str

The name of the storage account identifier.

share_name str

The name of the file share (container name, for Blob storage).

type str

The type of storage. Possible values are AzureBlob and AzureFiles.

mount_path str

The path to mount the storage within the site's runtime environment.

accessKey String

The access key for the storage account.

accountName String

The name of the storage account.

name String

The name of the storage account identifier.

shareName String

The name of the file share (container name, for Blob storage).

type String

The type of storage. Possible values are AzureBlob and AzureFiles.

mountPath String

The path to mount the storage within the site's runtime environment.

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.