We recommend using Azure Native.
azure.appservice.AppService
Explore with Pulumi AI
Manages an App Service (within an App Service Plan).
!> NOTE: This resource has been deprecated in version 5.0 of the provider and will be removed in version 6.0. Please use azure.appservice.LinuxWebApp
and azure.appservice.WindowsWebApp
resources instead.
Note: When using Slots - the
app_settings
,connection_string
andsite_config
blocks on theazure.appservice.AppService
resource will be overwritten when promoting a Slot using theazure.appservice.ActiveSlot
resource.
Example Usage
This example provisions a Windows App Service.
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const examplePlan = new azure.appservice.Plan("example", {
name: "example-appserviceplan",
location: example.location,
resourceGroupName: example.name,
sku: {
tier: "Standard",
size: "S1",
},
});
const exampleAppService = new azure.appservice.AppService("example", {
name: "example-app-service",
location: example.location,
resourceGroupName: example.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",
}],
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_plan = azure.appservice.Plan("example",
name="example-appserviceplan",
location=example.location,
resource_group_name=example.name,
sku={
"tier": "Standard",
"size": "S1",
})
example_app_service = azure.appservice.AppService("example",
name="example-app-service",
location=example.location,
resource_group_name=example.name,
app_service_plan_id=example_plan.id,
site_config={
"dotnet_framework_version": "v4.0",
"scm_type": "LocalGit",
},
app_settings={
"SOME_KEY": "some-value",
},
connection_strings=[{
"name": "Database",
"type": "SQLServer",
"value": "Server=some-server.mydomain.com;Integrated Security=SSPI",
}])
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/appservice"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
examplePlan, err := appservice.NewPlan(ctx, "example", &appservice.PlanArgs{
Name: pulumi.String("example-appserviceplan"),
Location: example.Location,
ResourceGroupName: example.Name,
Sku: &appservice.PlanSkuArgs{
Tier: pulumi.String("Standard"),
Size: pulumi.String("S1"),
},
})
if err != nil {
return err
}
_, err = appservice.NewAppService(ctx, "example", &appservice.AppServiceArgs{
Name: pulumi.String("example-app-service"),
Location: example.Location,
ResourceGroupName: example.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
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var examplePlan = new Azure.AppService.Plan("example", new()
{
Name = "example-appserviceplan",
Location = example.Location,
ResourceGroupName = example.Name,
Sku = new Azure.AppService.Inputs.PlanSkuArgs
{
Tier = "Standard",
Size = "S1",
},
});
var exampleAppService = new Azure.AppService.AppService("example", new()
{
Name = "example-app-service",
Location = example.Location,
ResourceGroupName = example.Name,
AppServicePlanId = examplePlan.Id,
SiteConfig = new Azure.AppService.Inputs.AppServiceSiteConfigArgs
{
DotnetFrameworkVersion = "v4.0",
ScmType = "LocalGit",
},
AppSettings =
{
{ "SOME_KEY", "some-value" },
},
ConnectionStrings = new[]
{
new Azure.AppService.Inputs.AppServiceConnectionStringArgs
{
Name = "Database",
Type = "SQLServer",
Value = "Server=some-server.mydomain.com;Integrated Security=SSPI",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.appservice.Plan;
import com.pulumi.azure.appservice.PlanArgs;
import com.pulumi.azure.appservice.inputs.PlanSkuArgs;
import com.pulumi.azure.appservice.AppService;
import com.pulumi.azure.appservice.AppServiceArgs;
import com.pulumi.azure.appservice.inputs.AppServiceSiteConfigArgs;
import com.pulumi.azure.appservice.inputs.AppServiceConnectionStringArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var examplePlan = new Plan("examplePlan", PlanArgs.builder()
.name("example-appserviceplan")
.location(example.location())
.resourceGroupName(example.name())
.sku(PlanSkuArgs.builder()
.tier("Standard")
.size("S1")
.build())
.build());
var exampleAppService = new AppService("exampleAppService", AppServiceArgs.builder()
.name("example-app-service")
.location(example.location())
.resourceGroupName(example.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());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
examplePlan:
type: azure:appservice:Plan
name: example
properties:
name: example-appserviceplan
location: ${example.location}
resourceGroupName: ${example.name}
sku:
tier: Standard
size: S1
exampleAppService:
type: azure:appservice:AppService
name: example
properties:
name: example-app-service
location: ${example.location}
resourceGroupName: ${example.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 AppService Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AppService(name: string, args: AppServiceArgs, opts?: CustomResourceOptions);
@overload
def AppService(resource_name: str,
args: AppServiceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AppService(resource_name: str,
opts: Optional[ResourceOptions] = None,
app_service_plan_id: Optional[str] = None,
resource_group_name: Optional[str] = None,
client_cert_enabled: Optional[bool] = None,
key_vault_reference_identity_id: Optional[str] = None,
client_affinity_enabled: Optional[bool] = None,
auth_settings: Optional[AppServiceAuthSettingsArgs] = 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,
backup: Optional[AppServiceBackupArgs] = None,
location: Optional[str] = None,
logs: Optional[AppServiceLogsArgs] = None,
name: Optional[str] = None,
app_settings: Optional[Mapping[str, str]] = None,
site_config: Optional[AppServiceSiteConfigArgs] = None,
source_control: Optional[AppServiceSourceControlArgs] = None,
storage_accounts: Optional[Sequence[AppServiceStorageAccountArgs]] = None,
tags: Optional[Mapping[str, str]] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var appServiceResource = new Azure.AppService.AppService("appServiceResource", new()
{
AppServicePlanId = "string",
ResourceGroupName = "string",
ClientCertEnabled = false,
KeyVaultReferenceIdentityId = "string",
ClientAffinityEnabled = false,
AuthSettings = new Azure.AppService.Inputs.AppServiceAuthSettingsArgs
{
Enabled = false,
Google = new Azure.AppService.Inputs.AppServiceAuthSettingsGoogleArgs
{
ClientId = "string",
ClientSecret = "string",
OauthScopes = new[]
{
"string",
},
},
AllowedExternalRedirectUrls = new[]
{
"string",
},
DefaultProvider = "string",
AdditionalLoginParams =
{
{ "string", "string" },
},
Facebook = new Azure.AppService.Inputs.AppServiceAuthSettingsFacebookArgs
{
AppId = "string",
AppSecret = "string",
OauthScopes = new[]
{
"string",
},
},
ActiveDirectory = new Azure.AppService.Inputs.AppServiceAuthSettingsActiveDirectoryArgs
{
ClientId = "string",
AllowedAudiences = new[]
{
"string",
},
ClientSecret = "string",
},
Issuer = "string",
Microsoft = new Azure.AppService.Inputs.AppServiceAuthSettingsMicrosoftArgs
{
ClientId = "string",
ClientSecret = "string",
OauthScopes = new[]
{
"string",
},
},
RuntimeVersion = "string",
TokenRefreshExtensionHours = 0,
TokenStoreEnabled = false,
Twitter = new Azure.AppService.Inputs.AppServiceAuthSettingsTwitterArgs
{
ConsumerKey = "string",
ConsumerSecret = "string",
},
UnauthenticatedClientAction = "string",
},
ClientCertMode = "string",
ConnectionStrings = new[]
{
new Azure.AppService.Inputs.AppServiceConnectionStringArgs
{
Name = "string",
Type = "string",
Value = "string",
},
},
Enabled = false,
HttpsOnly = false,
Identity = new Azure.AppService.Inputs.AppServiceIdentityArgs
{
Type = "string",
IdentityIds = new[]
{
"string",
},
PrincipalId = "string",
TenantId = "string",
},
Backup = new Azure.AppService.Inputs.AppServiceBackupArgs
{
Name = "string",
Schedule = new Azure.AppService.Inputs.AppServiceBackupScheduleArgs
{
FrequencyInterval = 0,
FrequencyUnit = "string",
KeepAtLeastOneBackup = false,
RetentionPeriodInDays = 0,
StartTime = "string",
},
StorageAccountUrl = "string",
Enabled = false,
},
Location = "string",
Logs = new Azure.AppService.Inputs.AppServiceLogsArgs
{
ApplicationLogs = new Azure.AppService.Inputs.AppServiceLogsApplicationLogsArgs
{
AzureBlobStorage = new Azure.AppService.Inputs.AppServiceLogsApplicationLogsAzureBlobStorageArgs
{
Level = "string",
RetentionInDays = 0,
SasUrl = "string",
},
FileSystemLevel = "string",
},
DetailedErrorMessagesEnabled = false,
FailedRequestTracingEnabled = false,
HttpLogs = new Azure.AppService.Inputs.AppServiceLogsHttpLogsArgs
{
AzureBlobStorage = new Azure.AppService.Inputs.AppServiceLogsHttpLogsAzureBlobStorageArgs
{
RetentionInDays = 0,
SasUrl = "string",
},
FileSystem = new Azure.AppService.Inputs.AppServiceLogsHttpLogsFileSystemArgs
{
RetentionInDays = 0,
RetentionInMb = 0,
},
},
},
Name = "string",
AppSettings =
{
{ "string", "string" },
},
SiteConfig = new Azure.AppService.Inputs.AppServiceSiteConfigArgs
{
AcrUseManagedIdentityCredentials = false,
AcrUserManagedIdentityClientId = "string",
AlwaysOn = false,
AppCommandLine = "string",
AutoSwapSlotName = "string",
Cors = new Azure.AppService.Inputs.AppServiceSiteConfigCorsArgs
{
AllowedOrigins = new[]
{
"string",
},
SupportCredentials = false,
},
DefaultDocuments = new[]
{
"string",
},
DotnetFrameworkVersion = "string",
FtpsState = "string",
HealthCheckPath = "string",
Http2Enabled = false,
IpRestrictions = new[]
{
new Azure.AppService.Inputs.AppServiceSiteConfigIpRestrictionArgs
{
Action = "string",
Headers = new Azure.AppService.Inputs.AppServiceSiteConfigIpRestrictionHeadersArgs
{
XAzureFdids = new[]
{
"string",
},
XFdHealthProbe = "string",
XForwardedFors = new[]
{
"string",
},
XForwardedHosts = new[]
{
"string",
},
},
IpAddress = "string",
Name = "string",
Priority = 0,
ServiceTag = "string",
VirtualNetworkSubnetId = "string",
},
},
JavaContainer = "string",
JavaContainerVersion = "string",
JavaVersion = "string",
LinuxFxVersion = "string",
LocalMysqlEnabled = false,
ManagedPipelineMode = "string",
MinTlsVersion = "string",
NumberOfWorkers = 0,
PhpVersion = "string",
PythonVersion = "string",
RemoteDebuggingEnabled = false,
RemoteDebuggingVersion = "string",
ScmIpRestrictions = new[]
{
new Azure.AppService.Inputs.AppServiceSiteConfigScmIpRestrictionArgs
{
Action = "string",
Headers = new Azure.AppService.Inputs.AppServiceSiteConfigScmIpRestrictionHeadersArgs
{
XAzureFdids = new[]
{
"string",
},
XFdHealthProbe = "string",
XForwardedFors = new[]
{
"string",
},
XForwardedHosts = new[]
{
"string",
},
},
IpAddress = "string",
Name = "string",
Priority = 0,
ServiceTag = "string",
VirtualNetworkSubnetId = "string",
},
},
ScmType = "string",
ScmUseMainIpRestriction = false,
Use32BitWorkerProcess = false,
VnetRouteAllEnabled = false,
WebsocketsEnabled = false,
WindowsFxVersion = "string",
},
SourceControl = new Azure.AppService.Inputs.AppServiceSourceControlArgs
{
Branch = "string",
ManualIntegration = false,
RepoUrl = "string",
RollbackEnabled = false,
UseMercurial = false,
},
StorageAccounts = new[]
{
new Azure.AppService.Inputs.AppServiceStorageAccountArgs
{
AccessKey = "string",
AccountName = "string",
Name = "string",
ShareName = "string",
Type = "string",
MountPath = "string",
},
},
Tags =
{
{ "string", "string" },
},
});
example, err := appservice.NewAppService(ctx, "appServiceResource", &appservice.AppServiceArgs{
AppServicePlanId: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
ClientCertEnabled: pulumi.Bool(false),
KeyVaultReferenceIdentityId: pulumi.String("string"),
ClientAffinityEnabled: pulumi.Bool(false),
AuthSettings: &appservice.AppServiceAuthSettingsArgs{
Enabled: pulumi.Bool(false),
Google: &appservice.AppServiceAuthSettingsGoogleArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
OauthScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
AllowedExternalRedirectUrls: pulumi.StringArray{
pulumi.String("string"),
},
DefaultProvider: pulumi.String("string"),
AdditionalLoginParams: pulumi.StringMap{
"string": pulumi.String("string"),
},
Facebook: &appservice.AppServiceAuthSettingsFacebookArgs{
AppId: pulumi.String("string"),
AppSecret: pulumi.String("string"),
OauthScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
ActiveDirectory: &appservice.AppServiceAuthSettingsActiveDirectoryArgs{
ClientId: pulumi.String("string"),
AllowedAudiences: pulumi.StringArray{
pulumi.String("string"),
},
ClientSecret: pulumi.String("string"),
},
Issuer: pulumi.String("string"),
Microsoft: &appservice.AppServiceAuthSettingsMicrosoftArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
OauthScopes: pulumi.StringArray{
pulumi.String("string"),
},
},
RuntimeVersion: pulumi.String("string"),
TokenRefreshExtensionHours: pulumi.Float64(0),
TokenStoreEnabled: pulumi.Bool(false),
Twitter: &appservice.AppServiceAuthSettingsTwitterArgs{
ConsumerKey: pulumi.String("string"),
ConsumerSecret: pulumi.String("string"),
},
UnauthenticatedClientAction: pulumi.String("string"),
},
ClientCertMode: pulumi.String("string"),
ConnectionStrings: appservice.AppServiceConnectionStringArray{
&appservice.AppServiceConnectionStringArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Enabled: pulumi.Bool(false),
HttpsOnly: pulumi.Bool(false),
Identity: &appservice.AppServiceIdentityArgs{
Type: pulumi.String("string"),
IdentityIds: pulumi.StringArray{
pulumi.String("string"),
},
PrincipalId: pulumi.String("string"),
TenantId: pulumi.String("string"),
},
Backup: &appservice.AppServiceBackupArgs{
Name: pulumi.String("string"),
Schedule: &appservice.AppServiceBackupScheduleArgs{
FrequencyInterval: pulumi.Int(0),
FrequencyUnit: pulumi.String("string"),
KeepAtLeastOneBackup: pulumi.Bool(false),
RetentionPeriodInDays: pulumi.Int(0),
StartTime: pulumi.String("string"),
},
StorageAccountUrl: pulumi.String("string"),
Enabled: pulumi.Bool(false),
},
Location: pulumi.String("string"),
Logs: &appservice.AppServiceLogsArgs{
ApplicationLogs: &appservice.AppServiceLogsApplicationLogsArgs{
AzureBlobStorage: &appservice.AppServiceLogsApplicationLogsAzureBlobStorageArgs{
Level: pulumi.String("string"),
RetentionInDays: pulumi.Int(0),
SasUrl: pulumi.String("string"),
},
FileSystemLevel: pulumi.String("string"),
},
DetailedErrorMessagesEnabled: pulumi.Bool(false),
FailedRequestTracingEnabled: pulumi.Bool(false),
HttpLogs: &appservice.AppServiceLogsHttpLogsArgs{
AzureBlobStorage: &appservice.AppServiceLogsHttpLogsAzureBlobStorageArgs{
RetentionInDays: pulumi.Int(0),
SasUrl: pulumi.String("string"),
},
FileSystem: &appservice.AppServiceLogsHttpLogsFileSystemArgs{
RetentionInDays: pulumi.Int(0),
RetentionInMb: pulumi.Int(0),
},
},
},
Name: pulumi.String("string"),
AppSettings: pulumi.StringMap{
"string": pulumi.String("string"),
},
SiteConfig: &appservice.AppServiceSiteConfigArgs{
AcrUseManagedIdentityCredentials: pulumi.Bool(false),
AcrUserManagedIdentityClientId: pulumi.String("string"),
AlwaysOn: pulumi.Bool(false),
AppCommandLine: pulumi.String("string"),
AutoSwapSlotName: pulumi.String("string"),
Cors: &appservice.AppServiceSiteConfigCorsArgs{
AllowedOrigins: pulumi.StringArray{
pulumi.String("string"),
},
SupportCredentials: pulumi.Bool(false),
},
DefaultDocuments: pulumi.StringArray{
pulumi.String("string"),
},
DotnetFrameworkVersion: pulumi.String("string"),
FtpsState: pulumi.String("string"),
HealthCheckPath: pulumi.String("string"),
Http2Enabled: pulumi.Bool(false),
IpRestrictions: appservice.AppServiceSiteConfigIpRestrictionArray{
&appservice.AppServiceSiteConfigIpRestrictionArgs{
Action: pulumi.String("string"),
Headers: &appservice.AppServiceSiteConfigIpRestrictionHeadersArgs{
XAzureFdids: pulumi.StringArray{
pulumi.String("string"),
},
XFdHealthProbe: pulumi.String("string"),
XForwardedFors: pulumi.StringArray{
pulumi.String("string"),
},
XForwardedHosts: pulumi.StringArray{
pulumi.String("string"),
},
},
IpAddress: pulumi.String("string"),
Name: pulumi.String("string"),
Priority: pulumi.Int(0),
ServiceTag: pulumi.String("string"),
VirtualNetworkSubnetId: pulumi.String("string"),
},
},
JavaContainer: pulumi.String("string"),
JavaContainerVersion: pulumi.String("string"),
JavaVersion: pulumi.String("string"),
LinuxFxVersion: pulumi.String("string"),
LocalMysqlEnabled: pulumi.Bool(false),
ManagedPipelineMode: pulumi.String("string"),
MinTlsVersion: pulumi.String("string"),
NumberOfWorkers: pulumi.Int(0),
PhpVersion: pulumi.String("string"),
PythonVersion: pulumi.String("string"),
RemoteDebuggingEnabled: pulumi.Bool(false),
RemoteDebuggingVersion: pulumi.String("string"),
ScmIpRestrictions: appservice.AppServiceSiteConfigScmIpRestrictionArray{
&appservice.AppServiceSiteConfigScmIpRestrictionArgs{
Action: pulumi.String("string"),
Headers: &appservice.AppServiceSiteConfigScmIpRestrictionHeadersArgs{
XAzureFdids: pulumi.StringArray{
pulumi.String("string"),
},
XFdHealthProbe: pulumi.String("string"),
XForwardedFors: pulumi.StringArray{
pulumi.String("string"),
},
XForwardedHosts: pulumi.StringArray{
pulumi.String("string"),
},
},
IpAddress: pulumi.String("string"),
Name: pulumi.String("string"),
Priority: pulumi.Int(0),
ServiceTag: pulumi.String("string"),
VirtualNetworkSubnetId: pulumi.String("string"),
},
},
ScmType: pulumi.String("string"),
ScmUseMainIpRestriction: pulumi.Bool(false),
Use32BitWorkerProcess: pulumi.Bool(false),
VnetRouteAllEnabled: pulumi.Bool(false),
WebsocketsEnabled: pulumi.Bool(false),
WindowsFxVersion: pulumi.String("string"),
},
SourceControl: &appservice.AppServiceSourceControlArgs{
Branch: pulumi.String("string"),
ManualIntegration: pulumi.Bool(false),
RepoUrl: pulumi.String("string"),
RollbackEnabled: pulumi.Bool(false),
UseMercurial: pulumi.Bool(false),
},
StorageAccounts: appservice.AppServiceStorageAccountArray{
&appservice.AppServiceStorageAccountArgs{
AccessKey: pulumi.String("string"),
AccountName: pulumi.String("string"),
Name: pulumi.String("string"),
ShareName: pulumi.String("string"),
Type: pulumi.String("string"),
MountPath: pulumi.String("string"),
},
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var appServiceResource = new AppService("appServiceResource", AppServiceArgs.builder()
.appServicePlanId("string")
.resourceGroupName("string")
.clientCertEnabled(false)
.keyVaultReferenceIdentityId("string")
.clientAffinityEnabled(false)
.authSettings(AppServiceAuthSettingsArgs.builder()
.enabled(false)
.google(AppServiceAuthSettingsGoogleArgs.builder()
.clientId("string")
.clientSecret("string")
.oauthScopes("string")
.build())
.allowedExternalRedirectUrls("string")
.defaultProvider("string")
.additionalLoginParams(Map.of("string", "string"))
.facebook(AppServiceAuthSettingsFacebookArgs.builder()
.appId("string")
.appSecret("string")
.oauthScopes("string")
.build())
.activeDirectory(AppServiceAuthSettingsActiveDirectoryArgs.builder()
.clientId("string")
.allowedAudiences("string")
.clientSecret("string")
.build())
.issuer("string")
.microsoft(AppServiceAuthSettingsMicrosoftArgs.builder()
.clientId("string")
.clientSecret("string")
.oauthScopes("string")
.build())
.runtimeVersion("string")
.tokenRefreshExtensionHours(0)
.tokenStoreEnabled(false)
.twitter(AppServiceAuthSettingsTwitterArgs.builder()
.consumerKey("string")
.consumerSecret("string")
.build())
.unauthenticatedClientAction("string")
.build())
.clientCertMode("string")
.connectionStrings(AppServiceConnectionStringArgs.builder()
.name("string")
.type("string")
.value("string")
.build())
.enabled(false)
.httpsOnly(false)
.identity(AppServiceIdentityArgs.builder()
.type("string")
.identityIds("string")
.principalId("string")
.tenantId("string")
.build())
.backup(AppServiceBackupArgs.builder()
.name("string")
.schedule(AppServiceBackupScheduleArgs.builder()
.frequencyInterval(0)
.frequencyUnit("string")
.keepAtLeastOneBackup(false)
.retentionPeriodInDays(0)
.startTime("string")
.build())
.storageAccountUrl("string")
.enabled(false)
.build())
.location("string")
.logs(AppServiceLogsArgs.builder()
.applicationLogs(AppServiceLogsApplicationLogsArgs.builder()
.azureBlobStorage(AppServiceLogsApplicationLogsAzureBlobStorageArgs.builder()
.level("string")
.retentionInDays(0)
.sasUrl("string")
.build())
.fileSystemLevel("string")
.build())
.detailedErrorMessagesEnabled(false)
.failedRequestTracingEnabled(false)
.httpLogs(AppServiceLogsHttpLogsArgs.builder()
.azureBlobStorage(AppServiceLogsHttpLogsAzureBlobStorageArgs.builder()
.retentionInDays(0)
.sasUrl("string")
.build())
.fileSystem(AppServiceLogsHttpLogsFileSystemArgs.builder()
.retentionInDays(0)
.retentionInMb(0)
.build())
.build())
.build())
.name("string")
.appSettings(Map.of("string", "string"))
.siteConfig(AppServiceSiteConfigArgs.builder()
.acrUseManagedIdentityCredentials(false)
.acrUserManagedIdentityClientId("string")
.alwaysOn(false)
.appCommandLine("string")
.autoSwapSlotName("string")
.cors(AppServiceSiteConfigCorsArgs.builder()
.allowedOrigins("string")
.supportCredentials(false)
.build())
.defaultDocuments("string")
.dotnetFrameworkVersion("string")
.ftpsState("string")
.healthCheckPath("string")
.http2Enabled(false)
.ipRestrictions(AppServiceSiteConfigIpRestrictionArgs.builder()
.action("string")
.headers(AppServiceSiteConfigIpRestrictionHeadersArgs.builder()
.xAzureFdids("string")
.xFdHealthProbe("string")
.xForwardedFors("string")
.xForwardedHosts("string")
.build())
.ipAddress("string")
.name("string")
.priority(0)
.serviceTag("string")
.virtualNetworkSubnetId("string")
.build())
.javaContainer("string")
.javaContainerVersion("string")
.javaVersion("string")
.linuxFxVersion("string")
.localMysqlEnabled(false)
.managedPipelineMode("string")
.minTlsVersion("string")
.numberOfWorkers(0)
.phpVersion("string")
.pythonVersion("string")
.remoteDebuggingEnabled(false)
.remoteDebuggingVersion("string")
.scmIpRestrictions(AppServiceSiteConfigScmIpRestrictionArgs.builder()
.action("string")
.headers(AppServiceSiteConfigScmIpRestrictionHeadersArgs.builder()
.xAzureFdids("string")
.xFdHealthProbe("string")
.xForwardedFors("string")
.xForwardedHosts("string")
.build())
.ipAddress("string")
.name("string")
.priority(0)
.serviceTag("string")
.virtualNetworkSubnetId("string")
.build())
.scmType("string")
.scmUseMainIpRestriction(false)
.use32BitWorkerProcess(false)
.vnetRouteAllEnabled(false)
.websocketsEnabled(false)
.windowsFxVersion("string")
.build())
.sourceControl(AppServiceSourceControlArgs.builder()
.branch("string")
.manualIntegration(false)
.repoUrl("string")
.rollbackEnabled(false)
.useMercurial(false)
.build())
.storageAccounts(AppServiceStorageAccountArgs.builder()
.accessKey("string")
.accountName("string")
.name("string")
.shareName("string")
.type("string")
.mountPath("string")
.build())
.tags(Map.of("string", "string"))
.build());
app_service_resource = azure.appservice.AppService("appServiceResource",
app_service_plan_id="string",
resource_group_name="string",
client_cert_enabled=False,
key_vault_reference_identity_id="string",
client_affinity_enabled=False,
auth_settings={
"enabled": False,
"google": {
"clientId": "string",
"clientSecret": "string",
"oauthScopes": ["string"],
},
"allowedExternalRedirectUrls": ["string"],
"defaultProvider": "string",
"additionalLoginParams": {
"string": "string",
},
"facebook": {
"appId": "string",
"appSecret": "string",
"oauthScopes": ["string"],
},
"activeDirectory": {
"clientId": "string",
"allowedAudiences": ["string"],
"clientSecret": "string",
},
"issuer": "string",
"microsoft": {
"clientId": "string",
"clientSecret": "string",
"oauthScopes": ["string"],
},
"runtimeVersion": "string",
"tokenRefreshExtensionHours": 0,
"tokenStoreEnabled": False,
"twitter": {
"consumerKey": "string",
"consumerSecret": "string",
},
"unauthenticatedClientAction": "string",
},
client_cert_mode="string",
connection_strings=[{
"name": "string",
"type": "string",
"value": "string",
}],
enabled=False,
https_only=False,
identity={
"type": "string",
"identityIds": ["string"],
"principalId": "string",
"tenantId": "string",
},
backup={
"name": "string",
"schedule": {
"frequencyInterval": 0,
"frequencyUnit": "string",
"keepAtLeastOneBackup": False,
"retentionPeriodInDays": 0,
"startTime": "string",
},
"storageAccountUrl": "string",
"enabled": False,
},
location="string",
logs={
"applicationLogs": {
"azureBlobStorage": {
"level": "string",
"retentionInDays": 0,
"sasUrl": "string",
},
"fileSystemLevel": "string",
},
"detailedErrorMessagesEnabled": False,
"failedRequestTracingEnabled": False,
"httpLogs": {
"azureBlobStorage": {
"retentionInDays": 0,
"sasUrl": "string",
},
"fileSystem": {
"retentionInDays": 0,
"retentionInMb": 0,
},
},
},
name="string",
app_settings={
"string": "string",
},
site_config={
"acrUseManagedIdentityCredentials": False,
"acrUserManagedIdentityClientId": "string",
"alwaysOn": False,
"appCommandLine": "string",
"autoSwapSlotName": "string",
"cors": {
"allowedOrigins": ["string"],
"supportCredentials": False,
},
"defaultDocuments": ["string"],
"dotnetFrameworkVersion": "string",
"ftpsState": "string",
"healthCheckPath": "string",
"http2Enabled": False,
"ipRestrictions": [{
"action": "string",
"headers": {
"xAzureFdids": ["string"],
"xFdHealthProbe": "string",
"xForwardedFors": ["string"],
"xForwardedHosts": ["string"],
},
"ipAddress": "string",
"name": "string",
"priority": 0,
"serviceTag": "string",
"virtualNetworkSubnetId": "string",
}],
"javaContainer": "string",
"javaContainerVersion": "string",
"javaVersion": "string",
"linuxFxVersion": "string",
"localMysqlEnabled": False,
"managedPipelineMode": "string",
"minTlsVersion": "string",
"numberOfWorkers": 0,
"phpVersion": "string",
"pythonVersion": "string",
"remoteDebuggingEnabled": False,
"remoteDebuggingVersion": "string",
"scmIpRestrictions": [{
"action": "string",
"headers": {
"xAzureFdids": ["string"],
"xFdHealthProbe": "string",
"xForwardedFors": ["string"],
"xForwardedHosts": ["string"],
},
"ipAddress": "string",
"name": "string",
"priority": 0,
"serviceTag": "string",
"virtualNetworkSubnetId": "string",
}],
"scmType": "string",
"scmUseMainIpRestriction": False,
"use32BitWorkerProcess": False,
"vnetRouteAllEnabled": False,
"websocketsEnabled": False,
"windowsFxVersion": "string",
},
source_control={
"branch": "string",
"manualIntegration": False,
"repoUrl": "string",
"rollbackEnabled": False,
"useMercurial": False,
},
storage_accounts=[{
"accessKey": "string",
"accountName": "string",
"name": "string",
"shareName": "string",
"type": "string",
"mountPath": "string",
}],
tags={
"string": "string",
})
const appServiceResource = new azure.appservice.AppService("appServiceResource", {
appServicePlanId: "string",
resourceGroupName: "string",
clientCertEnabled: false,
keyVaultReferenceIdentityId: "string",
clientAffinityEnabled: false,
authSettings: {
enabled: false,
google: {
clientId: "string",
clientSecret: "string",
oauthScopes: ["string"],
},
allowedExternalRedirectUrls: ["string"],
defaultProvider: "string",
additionalLoginParams: {
string: "string",
},
facebook: {
appId: "string",
appSecret: "string",
oauthScopes: ["string"],
},
activeDirectory: {
clientId: "string",
allowedAudiences: ["string"],
clientSecret: "string",
},
issuer: "string",
microsoft: {
clientId: "string",
clientSecret: "string",
oauthScopes: ["string"],
},
runtimeVersion: "string",
tokenRefreshExtensionHours: 0,
tokenStoreEnabled: false,
twitter: {
consumerKey: "string",
consumerSecret: "string",
},
unauthenticatedClientAction: "string",
},
clientCertMode: "string",
connectionStrings: [{
name: "string",
type: "string",
value: "string",
}],
enabled: false,
httpsOnly: false,
identity: {
type: "string",
identityIds: ["string"],
principalId: "string",
tenantId: "string",
},
backup: {
name: "string",
schedule: {
frequencyInterval: 0,
frequencyUnit: "string",
keepAtLeastOneBackup: false,
retentionPeriodInDays: 0,
startTime: "string",
},
storageAccountUrl: "string",
enabled: false,
},
location: "string",
logs: {
applicationLogs: {
azureBlobStorage: {
level: "string",
retentionInDays: 0,
sasUrl: "string",
},
fileSystemLevel: "string",
},
detailedErrorMessagesEnabled: false,
failedRequestTracingEnabled: false,
httpLogs: {
azureBlobStorage: {
retentionInDays: 0,
sasUrl: "string",
},
fileSystem: {
retentionInDays: 0,
retentionInMb: 0,
},
},
},
name: "string",
appSettings: {
string: "string",
},
siteConfig: {
acrUseManagedIdentityCredentials: false,
acrUserManagedIdentityClientId: "string",
alwaysOn: false,
appCommandLine: "string",
autoSwapSlotName: "string",
cors: {
allowedOrigins: ["string"],
supportCredentials: false,
},
defaultDocuments: ["string"],
dotnetFrameworkVersion: "string",
ftpsState: "string",
healthCheckPath: "string",
http2Enabled: false,
ipRestrictions: [{
action: "string",
headers: {
xAzureFdids: ["string"],
xFdHealthProbe: "string",
xForwardedFors: ["string"],
xForwardedHosts: ["string"],
},
ipAddress: "string",
name: "string",
priority: 0,
serviceTag: "string",
virtualNetworkSubnetId: "string",
}],
javaContainer: "string",
javaContainerVersion: "string",
javaVersion: "string",
linuxFxVersion: "string",
localMysqlEnabled: false,
managedPipelineMode: "string",
minTlsVersion: "string",
numberOfWorkers: 0,
phpVersion: "string",
pythonVersion: "string",
remoteDebuggingEnabled: false,
remoteDebuggingVersion: "string",
scmIpRestrictions: [{
action: "string",
headers: {
xAzureFdids: ["string"],
xFdHealthProbe: "string",
xForwardedFors: ["string"],
xForwardedHosts: ["string"],
},
ipAddress: "string",
name: "string",
priority: 0,
serviceTag: "string",
virtualNetworkSubnetId: "string",
}],
scmType: "string",
scmUseMainIpRestriction: false,
use32BitWorkerProcess: false,
vnetRouteAllEnabled: false,
websocketsEnabled: false,
windowsFxVersion: "string",
},
sourceControl: {
branch: "string",
manualIntegration: false,
repoUrl: "string",
rollbackEnabled: false,
useMercurial: false,
},
storageAccounts: [{
accessKey: "string",
accountName: "string",
name: "string",
shareName: "string",
type: "string",
mountPath: "string",
}],
tags: {
string: "string",
},
});
type: azure:appservice:AppService
properties:
appServicePlanId: string
appSettings:
string: string
authSettings:
activeDirectory:
allowedAudiences:
- string
clientId: string
clientSecret: string
additionalLoginParams:
string: string
allowedExternalRedirectUrls:
- string
defaultProvider: string
enabled: false
facebook:
appId: string
appSecret: string
oauthScopes:
- string
google:
clientId: string
clientSecret: string
oauthScopes:
- string
issuer: string
microsoft:
clientId: string
clientSecret: string
oauthScopes:
- string
runtimeVersion: string
tokenRefreshExtensionHours: 0
tokenStoreEnabled: false
twitter:
consumerKey: string
consumerSecret: string
unauthenticatedClientAction: string
backup:
enabled: false
name: string
schedule:
frequencyInterval: 0
frequencyUnit: string
keepAtLeastOneBackup: false
retentionPeriodInDays: 0
startTime: string
storageAccountUrl: string
clientAffinityEnabled: false
clientCertEnabled: false
clientCertMode: string
connectionStrings:
- name: string
type: string
value: string
enabled: false
httpsOnly: false
identity:
identityIds:
- string
principalId: string
tenantId: string
type: string
keyVaultReferenceIdentityId: string
location: string
logs:
applicationLogs:
azureBlobStorage:
level: string
retentionInDays: 0
sasUrl: string
fileSystemLevel: string
detailedErrorMessagesEnabled: false
failedRequestTracingEnabled: false
httpLogs:
azureBlobStorage:
retentionInDays: 0
sasUrl: string
fileSystem:
retentionInDays: 0
retentionInMb: 0
name: string
resourceGroupName: string
siteConfig:
acrUseManagedIdentityCredentials: false
acrUserManagedIdentityClientId: string
alwaysOn: false
appCommandLine: string
autoSwapSlotName: string
cors:
allowedOrigins:
- string
supportCredentials: false
defaultDocuments:
- string
dotnetFrameworkVersion: string
ftpsState: string
healthCheckPath: string
http2Enabled: false
ipRestrictions:
- action: string
headers:
xAzureFdids:
- string
xFdHealthProbe: string
xForwardedFors:
- string
xForwardedHosts:
- string
ipAddress: string
name: string
priority: 0
serviceTag: string
virtualNetworkSubnetId: string
javaContainer: string
javaContainerVersion: string
javaVersion: string
linuxFxVersion: string
localMysqlEnabled: false
managedPipelineMode: string
minTlsVersion: string
numberOfWorkers: 0
phpVersion: string
pythonVersion: string
remoteDebuggingEnabled: false
remoteDebuggingVersion: string
scmIpRestrictions:
- action: string
headers:
xAzureFdids:
- string
xFdHealthProbe: string
xForwardedFors:
- string
xForwardedHosts:
- string
ipAddress: string
name: string
priority: 0
serviceTag: string
virtualNetworkSubnetId: string
scmType: string
scmUseMainIpRestriction: false
use32BitWorkerProcess: false
vnetRouteAllEnabled: false
websocketsEnabled: false
windowsFxVersion: string
sourceControl:
branch: string
manualIntegration: false
repoUrl: string
rollbackEnabled: false
useMercurial: false
storageAccounts:
- accessKey: string
accountName: string
mountPath: string
name: string
shareName: string
type: string
tags:
string: string
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:
- App
Service stringPlan Id - The ID of the App Service Plan within which to create this App Service.
- Resource
Group stringName - The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
- App
Settings Dictionary<string, string> - A key-value pair of App Settings.
- Auth
Settings AppService Auth Settings - A
auth_settings
block as defined below. - Backup
App
Service Backup - A
backup
block as defined below. - Client
Affinity boolEnabled - Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?
- Client
Cert boolEnabled - Does the App Service require client certificates for incoming requests? Defaults to
false
. - Client
Cert stringMode - Mode of client certificates for this App Service. Possible values are
Required
,Optional
andOptionalInteractiveUser
. If this parameter is set,client_cert_enabled
must be set totrue
, otherwise this parameter is ignored. - Connection
Strings List<AppService Connection String> - One or more
connection_string
blocks as defined below. - Enabled bool
- Is the App Service Enabled? Defaults to
true
. - Https
Only bool - Can the App Service only be accessed via HTTPS? Defaults to
false
. - Identity
App
Service Identity - An
identity
block as defined below. - Key
Vault stringReference Identity Id - 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
App
Service Logs - A
logs
block as defined below. - Name string
- Specifies the name of the App Service. Changing this forces a new resource to be created.
- Site
Config AppService Site Config - A
site_config
block as defined below. - Source
Control AppService Source Control - A
source_control
block as defined below. - Storage
Accounts List<AppService Storage Account> - One or more
storage_account
blocks as defined below. - Dictionary<string, string>
- A mapping of tags to assign to the resource.
- App
Service stringPlan Id - The ID of the App Service Plan within which to create this App Service.
- Resource
Group stringName - The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
- App
Settings map[string]string - A key-value pair of App Settings.
- Auth
Settings AppService Auth Settings Args - A
auth_settings
block as defined below. - Backup
App
Service Backup Args - A
backup
block as defined below. - Client
Affinity boolEnabled - Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?
- Client
Cert boolEnabled - Does the App Service require client certificates for incoming requests? Defaults to
false
. - Client
Cert stringMode - Mode of client certificates for this App Service. Possible values are
Required
,Optional
andOptionalInteractiveUser
. If this parameter is set,client_cert_enabled
must be set totrue
, otherwise this parameter is ignored. - Connection
Strings []AppService Connection String Args - One or more
connection_string
blocks as defined below. - Enabled bool
- Is the App Service Enabled? Defaults to
true
. - Https
Only bool - Can the App Service only be accessed via HTTPS? Defaults to
false
. - Identity
App
Service Identity Args - An
identity
block as defined below. - Key
Vault stringReference Identity Id - 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
App
Service Logs Args - A
logs
block as defined below. - Name string
- Specifies the name of the App Service. Changing this forces a new resource to be created.
- Site
Config AppService Site Config Args - A
site_config
block as defined below. - Source
Control AppService Source Control Args - A
source_control
block as defined below. - Storage
Accounts []AppService Storage Account Args - One or more
storage_account
blocks as defined below. - map[string]string
- A mapping of tags to assign to the resource.
- app
Service StringPlan Id - The ID of the App Service Plan within which to create this App Service.
- resource
Group StringName - The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
- app
Settings Map<String,String> - A key-value pair of App Settings.
- auth
Settings AppService Auth Settings - A
auth_settings
block as defined below. - backup
App
Service Backup - A
backup
block as defined below. - client
Affinity BooleanEnabled - Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?
- client
Cert BooleanEnabled - Does the App Service require client certificates for incoming requests? Defaults to
false
. - client
Cert StringMode - Mode of client certificates for this App Service. Possible values are
Required
,Optional
andOptionalInteractiveUser
. If this parameter is set,client_cert_enabled
must be set totrue
, otherwise this parameter is ignored. - connection
Strings List<AppService Connection String> - One or more
connection_string
blocks as defined below. - enabled Boolean
- Is the App Service Enabled? Defaults to
true
. - https
Only Boolean - Can the App Service only be accessed via HTTPS? Defaults to
false
. - identity
App
Service Identity - An
identity
block as defined below. - key
Vault StringReference Identity Id - 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
App
Service Logs - A
logs
block as defined below. - name String
- Specifies the name of the App Service. Changing this forces a new resource to be created.
- site
Config AppService Site Config - A
site_config
block as defined below. - source
Control AppService Source Control - A
source_control
block as defined below. - storage
Accounts List<AppService Storage Account> - One or more
storage_account
blocks as defined below. - Map<String,String>
- A mapping of tags to assign to the resource.
- app
Service stringPlan Id - The ID of the App Service Plan within which to create this App Service.
- resource
Group stringName - The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
- app
Settings {[key: string]: string} - A key-value pair of App Settings.
- auth
Settings AppService Auth Settings - A
auth_settings
block as defined below. - backup
App
Service Backup - A
backup
block as defined below. - client
Affinity booleanEnabled - Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?
- client
Cert booleanEnabled - Does the App Service require client certificates for incoming requests? Defaults to
false
. - client
Cert stringMode - Mode of client certificates for this App Service. Possible values are
Required
,Optional
andOptionalInteractiveUser
. If this parameter is set,client_cert_enabled
must be set totrue
, otherwise this parameter is ignored. - connection
Strings AppService Connection String[] - One or more
connection_string
blocks as defined below. - enabled boolean
- Is the App Service Enabled? Defaults to
true
. - https
Only boolean - Can the App Service only be accessed via HTTPS? Defaults to
false
. - identity
App
Service Identity - An
identity
block as defined below. - key
Vault stringReference Identity Id - 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
App
Service Logs - A
logs
block as defined below. - name string
- Specifies the name of the App Service. Changing this forces a new resource to be created.
- site
Config AppService Site Config - A
site_config
block as defined below. - source
Control AppService Source Control - A
source_control
block as defined below. - storage
Accounts AppService Storage Account[] - One or more
storage_account
blocks as defined below. - {[key: string]: string}
- A mapping of tags to assign to the resource.
- app_
service_ strplan_ id - The ID of the App Service Plan within which to create this App Service.
- resource_
group_ strname - The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
- app_
settings Mapping[str, str] - A key-value pair of App Settings.
- auth_
settings AppService Auth Settings Args - A
auth_settings
block as defined below. - backup
App
Service Backup Args - A
backup
block as defined below. - client_
affinity_ boolenabled - Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?
- client_
cert_ boolenabled - Does the App Service require client certificates for incoming requests? Defaults to
false
. - client_
cert_ strmode - Mode of client certificates for this App Service. Possible values are
Required
,Optional
andOptionalInteractiveUser
. If this parameter is set,client_cert_enabled
must be set totrue
, otherwise this parameter is ignored. - connection_
strings Sequence[AppService Connection String Args] - One or more
connection_string
blocks as defined below. - enabled bool
- Is the App Service Enabled? Defaults to
true
. - https_
only bool - Can the App Service only be accessed via HTTPS? Defaults to
false
. - identity
App
Service Identity Args - An
identity
block as defined below. - key_
vault_ strreference_ identity_ id - 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
App
Service Logs Args - 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 AppService Site Config Args - A
site_config
block as defined below. - source_
control AppService Source Control Args - A
source_control
block as defined below. - storage_
accounts Sequence[AppService Storage Account Args] - One or more
storage_account
blocks as defined below. - Mapping[str, str]
- A mapping of tags to assign to the resource.
- app
Service StringPlan Id - The ID of the App Service Plan within which to create this App Service.
- resource
Group StringName - The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
- app
Settings Map<String> - A key-value pair of App Settings.
- auth
Settings Property Map - A
auth_settings
block as defined below. - backup Property Map
- A
backup
block as defined below. - client
Affinity BooleanEnabled - Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?
- client
Cert BooleanEnabled - Does the App Service require client certificates for incoming requests? Defaults to
false
. - client
Cert StringMode - Mode of client certificates for this App Service. Possible values are
Required
,Optional
andOptionalInteractiveUser
. If this parameter is set,client_cert_enabled
must be set totrue
, otherwise this parameter is ignored. - connection
Strings List<Property Map> - One or more
connection_string
blocks as defined below. - enabled Boolean
- Is the App Service Enabled? Defaults to
true
. - https
Only Boolean - Can the App Service only be accessed via HTTPS? Defaults to
false
. - identity Property Map
- An
identity
block as defined below. - key
Vault StringReference Identity Id - 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.
- site
Config Property Map - A
site_config
block as defined below. - source
Control Property Map - A
source_control
block as defined below. - storage
Accounts List<Property Map> - One or more
storage_account
blocks as defined below. - 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:
- Custom
Domain stringVerification Id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- Default
Site stringHostname - The Default Hostname associated with the App Service - such as
mysite.azurewebsites.net
- Id string
- The provider-assigned unique ID for this managed resource.
- Outbound
Ip List<string>Address Lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- Outbound
Ip stringAddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- Possible
Outbound List<string>Ip Address Lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12", "52.143.43.17"]
- not all of which are necessarily in use. Superset ofoutbound_ip_address_list
. - Possible
Outbound stringIp Addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - Site
Credentials List<AppService Site Credential> - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service.
- Custom
Domain stringVerification Id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- Default
Site stringHostname - The Default Hostname associated with the App Service - such as
mysite.azurewebsites.net
- Id string
- The provider-assigned unique ID for this managed resource.
- Outbound
Ip []stringAddress Lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- Outbound
Ip stringAddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- Possible
Outbound []stringIp Address Lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12", "52.143.43.17"]
- not all of which are necessarily in use. Superset ofoutbound_ip_address_list
. - Possible
Outbound stringIp Addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - Site
Credentials []AppService Site Credential - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service.
- custom
Domain StringVerification Id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Site StringHostname - The Default Hostname associated with the App Service - such as
mysite.azurewebsites.net
- id String
- The provider-assigned unique ID for this managed resource.
- outbound
Ip List<String>Address Lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- outbound
Ip StringAddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- possible
Outbound List<String>Ip Address Lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12", "52.143.43.17"]
- not all of which are necessarily in use. Superset ofoutbound_ip_address_list
. - possible
Outbound StringIp Addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - site
Credentials List<AppService Site Credential> - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service.
- custom
Domain stringVerification Id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Site stringHostname - The Default Hostname associated with the App Service - such as
mysite.azurewebsites.net
- id string
- The provider-assigned unique ID for this managed resource.
- outbound
Ip string[]Address Lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- outbound
Ip stringAddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- possible
Outbound string[]Ip Address Lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12", "52.143.43.17"]
- not all of which are necessarily in use. Superset ofoutbound_ip_address_list
. - possible
Outbound stringIp Addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - site
Credentials AppService Site Credential[] - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service.
- custom_
domain_ strverification_ id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default_
site_ strhostname - 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_ Sequence[str]address_ lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- outbound_
ip_ straddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- possible_
outbound_ Sequence[str]ip_ address_ lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12", "52.143.43.17"]
- not all of which are necessarily in use. Superset ofoutbound_ip_address_list
. - possible_
outbound_ strip_ addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - site_
credentials Sequence[AppService Site Credential] - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service.
- custom
Domain StringVerification Id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Site StringHostname - The Default Hostname associated with the App Service - such as
mysite.azurewebsites.net
- id String
- The provider-assigned unique ID for this managed resource.
- outbound
Ip List<String>Address Lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- outbound
Ip StringAddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- possible
Outbound List<String>Ip Address Lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12", "52.143.43.17"]
- not all of which are necessarily in use. Superset ofoutbound_ip_address_list
. - possible
Outbound StringIp Addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - site
Credentials List<Property Map> - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service.
Look up 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.
- App
Service stringPlan Id - The ID of the App Service Plan within which to create this App Service.
- App
Settings Dictionary<string, string> - A key-value pair of App Settings.
- Auth
Settings AppService Auth Settings - A
auth_settings
block as defined below. - Backup
App
Service Backup - A
backup
block as defined below. - Client
Affinity boolEnabled - Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?
- Client
Cert boolEnabled - Does the App Service require client certificates for incoming requests? Defaults to
false
. - Client
Cert stringMode - Mode of client certificates for this App Service. Possible values are
Required
,Optional
andOptionalInteractiveUser
. If this parameter is set,client_cert_enabled
must be set totrue
, otherwise this parameter is ignored. - Connection
Strings List<AppService Connection String> - One or more
connection_string
blocks as defined below. - Custom
Domain stringVerification Id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- Default
Site stringHostname - The Default Hostname associated with the App Service - such as
mysite.azurewebsites.net
- Enabled bool
- Is the App Service Enabled? Defaults to
true
. - Https
Only bool - Can the App Service only be accessed via HTTPS? Defaults to
false
. - Identity
App
Service Identity - An
identity
block as defined below. - Key
Vault stringReference Identity Id - 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
App
Service Logs - A
logs
block as defined below. - Name string
- Specifies the name of the App Service. Changing this forces a new resource to be created.
- Outbound
Ip List<string>Address Lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- Outbound
Ip stringAddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- Possible
Outbound List<string>Ip Address Lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12", "52.143.43.17"]
- not all of which are necessarily in use. Superset ofoutbound_ip_address_list
. - Possible
Outbound stringIp Addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - Resource
Group stringName - The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
- Site
Config AppService Site Config - A
site_config
block as defined below. - Site
Credentials List<AppService Site Credential> - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service. - Source
Control AppService Source Control - A
source_control
block as defined below. - Storage
Accounts List<AppService Storage Account> - One or more
storage_account
blocks as defined below. - Dictionary<string, string>
- A mapping of tags to assign to the resource.
- App
Service stringPlan Id - The ID of the App Service Plan within which to create this App Service.
- App
Settings map[string]string - A key-value pair of App Settings.
- Auth
Settings AppService Auth Settings Args - A
auth_settings
block as defined below. - Backup
App
Service Backup Args - A
backup
block as defined below. - Client
Affinity boolEnabled - Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?
- Client
Cert boolEnabled - Does the App Service require client certificates for incoming requests? Defaults to
false
. - Client
Cert stringMode - Mode of client certificates for this App Service. Possible values are
Required
,Optional
andOptionalInteractiveUser
. If this parameter is set,client_cert_enabled
must be set totrue
, otherwise this parameter is ignored. - Connection
Strings []AppService Connection String Args - One or more
connection_string
blocks as defined below. - Custom
Domain stringVerification Id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- Default
Site stringHostname - The Default Hostname associated with the App Service - such as
mysite.azurewebsites.net
- Enabled bool
- Is the App Service Enabled? Defaults to
true
. - Https
Only bool - Can the App Service only be accessed via HTTPS? Defaults to
false
. - Identity
App
Service Identity Args - An
identity
block as defined below. - Key
Vault stringReference Identity Id - 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
App
Service Logs Args - A
logs
block as defined below. - Name string
- Specifies the name of the App Service. Changing this forces a new resource to be created.
- Outbound
Ip []stringAddress Lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- Outbound
Ip stringAddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- Possible
Outbound []stringIp Address Lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12", "52.143.43.17"]
- not all of which are necessarily in use. Superset ofoutbound_ip_address_list
. - Possible
Outbound stringIp Addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - Resource
Group stringName - The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
- Site
Config AppService Site Config Args - A
site_config
block as defined below. - Site
Credentials []AppService Site Credential Args - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service. - Source
Control AppService Source Control Args - A
source_control
block as defined below. - Storage
Accounts []AppService Storage Account Args - One or more
storage_account
blocks as defined below. - map[string]string
- A mapping of tags to assign to the resource.
- app
Service StringPlan Id - The ID of the App Service Plan within which to create this App Service.
- app
Settings Map<String,String> - A key-value pair of App Settings.
- auth
Settings AppService Auth Settings - A
auth_settings
block as defined below. - backup
App
Service Backup - A
backup
block as defined below. - client
Affinity BooleanEnabled - Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?
- client
Cert BooleanEnabled - Does the App Service require client certificates for incoming requests? Defaults to
false
. - client
Cert StringMode - Mode of client certificates for this App Service. Possible values are
Required
,Optional
andOptionalInteractiveUser
. If this parameter is set,client_cert_enabled
must be set totrue
, otherwise this parameter is ignored. - connection
Strings List<AppService Connection String> - One or more
connection_string
blocks as defined below. - custom
Domain StringVerification Id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Site StringHostname - The Default Hostname associated with the App Service - such as
mysite.azurewebsites.net
- enabled Boolean
- Is the App Service Enabled? Defaults to
true
. - https
Only Boolean - Can the App Service only be accessed via HTTPS? Defaults to
false
. - identity
App
Service Identity - An
identity
block as defined below. - key
Vault StringReference Identity Id - 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
App
Service Logs - A
logs
block as defined below. - name String
- Specifies the name of the App Service. Changing this forces a new resource to be created.
- outbound
Ip List<String>Address Lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- outbound
Ip StringAddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- possible
Outbound List<String>Ip Address Lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12", "52.143.43.17"]
- not all of which are necessarily in use. Superset ofoutbound_ip_address_list
. - possible
Outbound StringIp Addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - resource
Group StringName - The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
- site
Config AppService Site Config - A
site_config
block as defined below. - site
Credentials List<AppService Site Credential> - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service. - source
Control AppService Source Control - A
source_control
block as defined below. - storage
Accounts List<AppService Storage Account> - One or more
storage_account
blocks as defined below. - Map<String,String>
- A mapping of tags to assign to the resource.
- app
Service stringPlan Id - The ID of the App Service Plan within which to create this App Service.
- app
Settings {[key: string]: string} - A key-value pair of App Settings.
- auth
Settings AppService Auth Settings - A
auth_settings
block as defined below. - backup
App
Service Backup - A
backup
block as defined below. - client
Affinity booleanEnabled - Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?
- client
Cert booleanEnabled - Does the App Service require client certificates for incoming requests? Defaults to
false
. - client
Cert stringMode - Mode of client certificates for this App Service. Possible values are
Required
,Optional
andOptionalInteractiveUser
. If this parameter is set,client_cert_enabled
must be set totrue
, otherwise this parameter is ignored. - connection
Strings AppService Connection String[] - One or more
connection_string
blocks as defined below. - custom
Domain stringVerification Id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Site stringHostname - The Default Hostname associated with the App Service - such as
mysite.azurewebsites.net
- enabled boolean
- Is the App Service Enabled? Defaults to
true
. - https
Only boolean - Can the App Service only be accessed via HTTPS? Defaults to
false
. - identity
App
Service Identity - An
identity
block as defined below. - key
Vault stringReference Identity Id - 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
App
Service Logs - A
logs
block as defined below. - name string
- Specifies the name of the App Service. Changing this forces a new resource to be created.
- outbound
Ip string[]Address Lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- outbound
Ip stringAddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- possible
Outbound string[]Ip Address Lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12", "52.143.43.17"]
- not all of which are necessarily in use. Superset ofoutbound_ip_address_list
. - possible
Outbound stringIp Addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - resource
Group stringName - The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
- site
Config AppService Site Config - A
site_config
block as defined below. - site
Credentials AppService Site Credential[] - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service. - source
Control AppService Source Control - A
source_control
block as defined below. - storage
Accounts AppService Storage Account[] - One or more
storage_account
blocks as defined below. - {[key: string]: string}
- A mapping of tags to assign to the resource.
- app_
service_ strplan_ id - 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 AppService Auth Settings Args - A
auth_settings
block as defined below. - backup
App
Service Backup Args - A
backup
block as defined below. - client_
affinity_ boolenabled - Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?
- client_
cert_ boolenabled - Does the App Service require client certificates for incoming requests? Defaults to
false
. - client_
cert_ strmode - Mode of client certificates for this App Service. Possible values are
Required
,Optional
andOptionalInteractiveUser
. If this parameter is set,client_cert_enabled
must be set totrue
, otherwise this parameter is ignored. - connection_
strings Sequence[AppService Connection String Args] - One or more
connection_string
blocks as defined below. - custom_
domain_ strverification_ id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default_
site_ strhostname - The Default Hostname associated with the App Service - such as
mysite.azurewebsites.net
- enabled bool
- Is the App Service Enabled? Defaults to
true
. - https_
only bool - Can the App Service only be accessed via HTTPS? Defaults to
false
. - identity
App
Service Identity Args - An
identity
block as defined below. - key_
vault_ strreference_ identity_ id - 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
App
Service Logs Args - 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_ Sequence[str]address_ lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- outbound_
ip_ straddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- possible_
outbound_ Sequence[str]ip_ address_ lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12", "52.143.43.17"]
- not all of which are necessarily in use. Superset ofoutbound_ip_address_list
. - possible_
outbound_ strip_ addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - resource_
group_ strname - The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
- site_
config AppService Site Config Args - A
site_config
block as defined below. - site_
credentials Sequence[AppService Site Credential Args] - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service. - source_
control AppService Source Control Args - A
source_control
block as defined below. - storage_
accounts Sequence[AppService Storage Account Args] - One or more
storage_account
blocks as defined below. - Mapping[str, str]
- A mapping of tags to assign to the resource.
- app
Service StringPlan Id - The ID of the App Service Plan within which to create this App Service.
- app
Settings Map<String> - A key-value pair of App Settings.
- auth
Settings Property Map - A
auth_settings
block as defined below. - backup Property Map
- A
backup
block as defined below. - client
Affinity BooleanEnabled - Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?
- client
Cert BooleanEnabled - Does the App Service require client certificates for incoming requests? Defaults to
false
. - client
Cert StringMode - Mode of client certificates for this App Service. Possible values are
Required
,Optional
andOptionalInteractiveUser
. If this parameter is set,client_cert_enabled
must be set totrue
, otherwise this parameter is ignored. - connection
Strings List<Property Map> - One or more
connection_string
blocks as defined below. - custom
Domain StringVerification Id - An identifier used by App Service to perform domain ownership verification via DNS TXT record.
- default
Site StringHostname - The Default Hostname associated with the App Service - such as
mysite.azurewebsites.net
- enabled Boolean
- Is the App Service Enabled? Defaults to
true
. - https
Only Boolean - Can the App Service only be accessed via HTTPS? Defaults to
false
. - identity Property Map
- An
identity
block as defined below. - key
Vault StringReference Identity Id - 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.
- outbound
Ip List<String>Address Lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12"]
- outbound
Ip StringAddresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12
- possible
Outbound List<String>Ip Address Lists - A list of outbound IP addresses - such as
["52.23.25.3", "52.143.43.12", "52.143.43.17"]
- not all of which are necessarily in use. Superset ofoutbound_ip_address_list
. - possible
Outbound StringIp Addresses - A comma separated list of outbound IP addresses - such as
52.23.25.3,52.143.43.12,52.143.43.17
- not all of which are necessarily in use. Superset ofoutbound_ip_addresses
. - resource
Group StringName - The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
- site
Config Property Map - A
site_config
block as defined below. - site
Credentials List<Property Map> - A
site_credential
block as defined below, which contains the site-level credentials used to publish to this App Service. - source
Control Property Map - A
source_control
block as defined below. - storage
Accounts List<Property Map> - One or more
storage_account
blocks as defined below. - Map<String>
- A mapping of tags to assign to the resource.
Supporting Types
AppServiceAuthSettings, AppServiceAuthSettingsArgs
- Enabled bool
- Is Authentication enabled?
- Active
Directory AppService Auth Settings Active Directory - A
active_directory
block as defined below. - Additional
Login Dictionary<string, string>Params - 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 List<string>Redirect Urls - External URLs that can be redirected to as part of logging in or logging out of the app.
- Default
Provider string The default provider to use when multiple providers have been set up. Possible values are
AzureActiveDirectory
,Facebook
,Google
,MicrosoftAccount
andTwitter
.NOTE: When using multiple providers, the default provider must be set for settings like
unauthenticated_client_action
to work.- Facebook
App
Service Auth Settings Facebook - A
facebook
block as defined below. - Google
App
Service Auth Settings Google - 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
App
Service Auth Settings Microsoft - A
microsoft
block as defined below. - Runtime
Version string - The runtime version of the Authentication/Authorization module.
- Token
Refresh doubleExtension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
. - Token
Store boolEnabled - If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to
false
. - Twitter
App
Service Auth Settings Twitter - A
twitter
block as defined below. - Unauthenticated
Client stringAction - The action to take when an unauthenticated client attempts to access the app. Possible values are
AllowAnonymous
andRedirectToLoginPage
.
- Enabled bool
- Is Authentication enabled?
- Active
Directory AppService Auth Settings Active Directory - A
active_directory
block as defined below. - Additional
Login map[string]stringParams - 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 []stringRedirect Urls - External URLs that can be redirected to as part of logging in or logging out of the app.
- Default
Provider string The default provider to use when multiple providers have been set up. Possible values are
AzureActiveDirectory
,Facebook
,Google
,MicrosoftAccount
andTwitter
.NOTE: When using multiple providers, the default provider must be set for settings like
unauthenticated_client_action
to work.- Facebook
App
Service Auth Settings Facebook - A
facebook
block as defined below. - Google
App
Service Auth Settings Google - 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
App
Service Auth Settings Microsoft - A
microsoft
block as defined below. - Runtime
Version string - The runtime version of the Authentication/Authorization module.
- Token
Refresh float64Extension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
. - Token
Store boolEnabled - If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to
false
. - Twitter
App
Service Auth Settings Twitter - A
twitter
block as defined below. - Unauthenticated
Client stringAction - The action to take when an unauthenticated client attempts to access the app. Possible values are
AllowAnonymous
andRedirectToLoginPage
.
- enabled Boolean
- Is Authentication enabled?
- active
Directory AppService Auth Settings Active Directory - A
active_directory
block as defined below. - additional
Login Map<String,String>Params - 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 List<String>Redirect Urls - External URLs that can be redirected to as part of logging in or logging out of the app.
- default
Provider String The default provider to use when multiple providers have been set up. Possible values are
AzureActiveDirectory
,Facebook
,Google
,MicrosoftAccount
andTwitter
.NOTE: When using multiple providers, the default provider must be set for settings like
unauthenticated_client_action
to work.- facebook
App
Service Auth Settings Facebook - A
facebook
block as defined below. - google
App
Service Auth Settings Google - 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
App
Service Auth Settings Microsoft - A
microsoft
block as defined below. - runtime
Version String - The runtime version of the Authentication/Authorization module.
- token
Refresh DoubleExtension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
. - token
Store BooleanEnabled - If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to
false
. - twitter
App
Service Auth Settings Twitter - A
twitter
block as defined below. - unauthenticated
Client StringAction - The action to take when an unauthenticated client attempts to access the app. Possible values are
AllowAnonymous
andRedirectToLoginPage
.
- enabled boolean
- Is Authentication enabled?
- active
Directory AppService Auth Settings Active Directory - A
active_directory
block as defined below. - additional
Login {[key: string]: string}Params - 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 string[]Redirect Urls - External URLs that can be redirected to as part of logging in or logging out of the app.
- default
Provider string The default provider to use when multiple providers have been set up. Possible values are
AzureActiveDirectory
,Facebook
,Google
,MicrosoftAccount
andTwitter
.NOTE: When using multiple providers, the default provider must be set for settings like
unauthenticated_client_action
to work.- facebook
App
Service Auth Settings Facebook - A
facebook
block as defined below. - google
App
Service Auth Settings Google - 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
App
Service Auth Settings Microsoft - A
microsoft
block as defined below. - runtime
Version string - The runtime version of the Authentication/Authorization module.
- token
Refresh numberExtension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
. - token
Store booleanEnabled - If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to
false
. - twitter
App
Service Auth Settings Twitter - A
twitter
block as defined below. - unauthenticated
Client stringAction - The action to take when an unauthenticated client attempts to access the app. Possible values are
AllowAnonymous
andRedirectToLoginPage
.
- enabled bool
- Is Authentication enabled?
- active_
directory AppService Auth Settings Active Directory - A
active_directory
block as defined below. - additional_
login_ Mapping[str, str]params - 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_ Sequence[str]redirect_ urls - 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
andTwitter
.NOTE: When using multiple providers, the default provider must be set for settings like
unauthenticated_client_action
to work.- facebook
App
Service Auth Settings Facebook - A
facebook
block as defined below. - google
App
Service Auth Settings Google - 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
App
Service Auth Settings Microsoft - A
microsoft
block as defined below. - runtime_
version str - The runtime version of the Authentication/Authorization module.
- token_
refresh_ floatextension_ hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
. - token_
store_ boolenabled - If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to
false
. - twitter
App
Service Auth Settings Twitter - A
twitter
block as defined below. - unauthenticated_
client_ straction - The action to take when an unauthenticated client attempts to access the app. Possible values are
AllowAnonymous
andRedirectToLoginPage
.
- enabled Boolean
- Is Authentication enabled?
- active
Directory Property Map - A
active_directory
block as defined below. - additional
Login Map<String>Params - 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 List<String>Redirect Urls - External URLs that can be redirected to as part of logging in or logging out of the app.
- default
Provider String The default provider to use when multiple providers have been set up. Possible values are
AzureActiveDirectory
,Facebook
,Google
,MicrosoftAccount
andTwitter
.NOTE: When using multiple providers, the default provider must be set for settings like
unauthenticated_client_action
to work.- 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. - runtime
Version String - The runtime version of the Authentication/Authorization module.
- token
Refresh NumberExtension Hours - The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to
72
. - token
Store BooleanEnabled - 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. - unauthenticated
Client StringAction - The action to take when an unauthenticated client attempts to access the app. Possible values are
AllowAnonymous
andRedirectToLoginPage
.
AppServiceAuthSettingsActiveDirectory, AppServiceAuthSettingsActiveDirectoryArgs
- Client
Id string - The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.
- Allowed
Audiences List<string> - Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- Client
Secret string - The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.
- Client
Id string - The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.
- Allowed
Audiences []string - Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- Client
Secret string - The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.
- client
Id String - The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.
- allowed
Audiences List<String> - Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- client
Secret String - The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.
- client
Id string - The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.
- allowed
Audiences string[] - Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- client
Secret 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.
- client
Id String - The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.
- allowed
Audiences List<String> - Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
- client
Secret String - The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.
AppServiceAuthSettingsFacebook, AppServiceAuthSettingsFacebookArgs
- App
Id string - The App ID of the Facebook app used for login
- App
Secret string - The App Secret of the Facebook app used for Facebook login.
- Oauth
Scopes List<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 string - The App ID of the Facebook app used for login
- App
Secret string - The App Secret of the Facebook app used for Facebook login.
- Oauth
Scopes []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 String - The App ID of the Facebook app used for login
- app
Secret String - The App Secret of the Facebook app used for Facebook login.
- oauth
Scopes List<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 string - The App ID of the Facebook app used for login
- app
Secret string - The App Secret of the Facebook app used for Facebook login.
- oauth
Scopes 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
- app
Id String - The App ID of the Facebook app used for login
- app
Secret String - The App Secret of the Facebook app used for Facebook login.
- oauth
Scopes 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, AppServiceAuthSettingsGoogleArgs
- Client
Id string - The OpenID Connect Client ID for the Google web application.
- Client
Secret string - The client secret associated with the Google web application.
- Oauth
Scopes 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/
- Client
Id string - The OpenID Connect Client ID for the Google web application.
- Client
Secret string - The client secret associated with the Google web application.
- Oauth
Scopes []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 String - The OpenID Connect Client ID for the Google web application.
- client
Secret String - The client secret associated with the Google web application.
- oauth
Scopes 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/
- client
Id string - The OpenID Connect Client ID for the Google web application.
- client
Secret string - The client secret associated with the Google web application.
- oauth
Scopes 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/
- client
Id String - The OpenID Connect Client ID for the Google web application.
- client
Secret String - The client secret associated with the Google web application.
- oauth
Scopes 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, AppServiceAuthSettingsMicrosoftArgs
- Client
Id string - The OAuth 2.0 client ID that was created for the app used for authentication.
- Client
Secret string - The OAuth 2.0 client secret that was created for the app used for authentication.
- Oauth
Scopes 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
- Client
Id string - The OAuth 2.0 client ID that was created for the app used for authentication.
- Client
Secret string - The OAuth 2.0 client secret that was created for the app used for authentication.
- Oauth
Scopes []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 String - The OAuth 2.0 client ID that was created for the app used for authentication.
- client
Secret String - The OAuth 2.0 client secret that was created for the app used for authentication.
- oauth
Scopes 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
- client
Id string - The OAuth 2.0 client ID that was created for the app used for authentication.
- client
Secret string - The OAuth 2.0 client secret that was created for the app used for authentication.
- oauth
Scopes 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
- client
Id String - The OAuth 2.0 client ID that was created for the app used for authentication.
- client
Secret String - The OAuth 2.0 client secret that was created for the app used for authentication.
- oauth
Scopes 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, AppServiceAuthSettingsTwitterArgs
- Consumer
Key string - The consumer key of the Twitter app used for login
- Consumer
Secret string - The consumer secret of the Twitter app used for login.
- Consumer
Key string - The consumer key of the Twitter app used for login
- Consumer
Secret string - The consumer secret of the Twitter app used for login.
- consumer
Key String - The consumer key of the Twitter app used for login
- consumer
Secret String - The consumer secret of the Twitter app used for login.
- consumer
Key string - The consumer key of the Twitter app used for login
- consumer
Secret string - The consumer secret of the Twitter app used for login.
- consumer_
key str - The consumer key of the Twitter app used for login
- consumer_
secret str - The consumer secret of the Twitter app used for login.
- consumer
Key String - The consumer key of the Twitter app used for login
- consumer
Secret String - The consumer secret of the Twitter app used for login.
AppServiceBackup, AppServiceBackupArgs
- Name string
- Specifies the name for this Backup.
- Schedule
App
Service Backup Schedule - A
schedule
block as defined below. - Storage
Account stringUrl - The SAS URL to a Storage Container where Backups should be saved.
- Enabled bool
- Is this Backup enabled? Defaults to
true
.
- Name string
- Specifies the name for this Backup.
- Schedule
App
Service Backup Schedule - A
schedule
block as defined below. - Storage
Account stringUrl - The SAS URL to a Storage Container where Backups should be saved.
- Enabled bool
- Is this Backup enabled? Defaults to
true
.
- name String
- Specifies the name for this Backup.
- schedule
App
Service Backup Schedule - A
schedule
block as defined below. - storage
Account StringUrl - The SAS URL to a Storage Container where Backups should be saved.
- enabled Boolean
- Is this Backup enabled? Defaults to
true
.
- name string
- Specifies the name for this Backup.
- schedule
App
Service Backup Schedule - A
schedule
block as defined below. - storage
Account stringUrl - The SAS URL to a Storage Container where Backups should be saved.
- enabled boolean
- Is this Backup enabled? Defaults to
true
.
- name str
- Specifies the name for this Backup.
- schedule
App
Service Backup Schedule - A
schedule
block as defined below. - storage_
account_ strurl - The SAS URL to a Storage Container where Backups should be saved.
- enabled bool
- Is this Backup enabled? Defaults to
true
.
- name String
- Specifies the name for this Backup.
- schedule Property Map
- A
schedule
block as defined below. - storage
Account StringUrl - The SAS URL to a Storage Container where Backups should be saved.
- enabled Boolean
- Is this Backup enabled? Defaults to
true
.
AppServiceBackupSchedule, AppServiceBackupScheduleArgs
- Frequency
Interval int - Sets how often the backup should be executed.
- Frequency
Unit string - Sets the unit of time for how often the backup should be executed. Possible values are
Day
orHour
. - Keep
At boolLeast One Backup - Should at least one backup always be kept in the Storage Account by the Retention Policy, regardless of how old it is?
- Retention
Period intIn Days - Specifies the number of days after which Backups should be deleted. Defaults to
30
. - Start
Time string - Sets when the schedule should start working.
- Frequency
Interval int - Sets how often the backup should be executed.
- Frequency
Unit string - Sets the unit of time for how often the backup should be executed. Possible values are
Day
orHour
. - Keep
At boolLeast One Backup - Should at least one backup always be kept in the Storage Account by the Retention Policy, regardless of how old it is?
- Retention
Period intIn Days - Specifies the number of days after which Backups should be deleted. Defaults to
30
. - Start
Time string - Sets when the schedule should start working.
- frequency
Interval Integer - Sets how often the backup should be executed.
- frequency
Unit String - Sets the unit of time for how often the backup should be executed. Possible values are
Day
orHour
. - keep
At BooleanLeast One Backup - Should at least one backup always be kept in the Storage Account by the Retention Policy, regardless of how old it is?
- retention
Period IntegerIn Days - Specifies the number of days after which Backups should be deleted. Defaults to
30
. - start
Time String - Sets when the schedule should start working.
- frequency
Interval number - Sets how often the backup should be executed.
- frequency
Unit string - Sets the unit of time for how often the backup should be executed. Possible values are
Day
orHour
. - keep
At booleanLeast One Backup - Should at least one backup always be kept in the Storage Account by the Retention Policy, regardless of how old it is?
- retention
Period numberIn Days - Specifies the number of days after which Backups should be deleted. Defaults to
30
. - start
Time 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
orHour
. - keep_
at_ boolleast_ one_ backup - Should at least one backup always be kept in the Storage Account by the Retention Policy, regardless of how old it is?
- retention_
period_ intin_ days - Specifies the number of days after which Backups should be deleted. Defaults to
30
. - start_
time str - Sets when the schedule should start working.
- frequency
Interval Number - Sets how often the backup should be executed.
- frequency
Unit String - Sets the unit of time for how often the backup should be executed. Possible values are
Day
orHour
. - keep
At BooleanLeast One Backup - Should at least one backup always be kept in the Storage Account by the Retention Policy, regardless of how old it is?
- retention
Period NumberIn Days - Specifies the number of days after which Backups should be deleted. Defaults to
30
. - start
Time String - Sets when the schedule should start working.
AppServiceConnectionString, AppServiceConnectionStringArgs
AppServiceIdentity, AppServiceIdentityArgs
- 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 theidentity_ids
field, andSystemAssigned, UserAssigned
which assigns both a system managed identity as well as the specified user assigned identities.NOTE: When
type
is set toSystemAssigned
, The assignedprincipal_id
andtenant_id
can be retrieved after the App Service has been created. More details are available below.- Identity
Ids List<string> - Specifies a list of user managed identity ids to be assigned. Required if
type
isUserAssigned
. - Principal
Id string - The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.
- Tenant
Id 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 theidentity_ids
field, andSystemAssigned, UserAssigned
which assigns both a system managed identity as well as the specified user assigned identities.NOTE: When
type
is set toSystemAssigned
, The assignedprincipal_id
andtenant_id
can be retrieved after the App Service has been created. More details are available below.- Identity
Ids []string - Specifies a list of user managed identity ids to be assigned. Required if
type
isUserAssigned
. - Principal
Id string - The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.
- Tenant
Id 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 theidentity_ids
field, andSystemAssigned, UserAssigned
which assigns both a system managed identity as well as the specified user assigned identities.NOTE: When
type
is set toSystemAssigned
, The assignedprincipal_id
andtenant_id
can be retrieved after the App Service has been created. More details are available below.- identity
Ids List<String> - Specifies a list of user managed identity ids to be assigned. Required if
type
isUserAssigned
. - principal
Id String - The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.
- tenant
Id 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 theidentity_ids
field, andSystemAssigned, UserAssigned
which assigns both a system managed identity as well as the specified user assigned identities.NOTE: When
type
is set toSystemAssigned
, The assignedprincipal_id
andtenant_id
can be retrieved after the App Service has been created. More details are available below.- identity
Ids string[] - Specifies a list of user managed identity ids to be assigned. Required if
type
isUserAssigned
. - principal
Id string - The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.
- tenant
Id 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 theidentity_ids
field, andSystemAssigned, UserAssigned
which assigns both a system managed identity as well as the specified user assigned identities.NOTE: When
type
is set toSystemAssigned
, The assignedprincipal_id
andtenant_id
can be retrieved after the App Service has been created. More details are available below.- identity_
ids Sequence[str] - Specifies a list of user managed identity ids to be assigned. Required if
type
isUserAssigned
. - 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 theidentity_ids
field, andSystemAssigned, UserAssigned
which assigns both a system managed identity as well as the specified user assigned identities.NOTE: When
type
is set toSystemAssigned
, The assignedprincipal_id
andtenant_id
can be retrieved after the App Service has been created. More details are available below.- identity
Ids List<String> - Specifies a list of user managed identity ids to be assigned. Required if
type
isUserAssigned
. - principal
Id String - The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.
- tenant
Id String - The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.
AppServiceLogs, AppServiceLogsArgs
- Application
Logs AppService Logs Application Logs - An
application_logs
block as defined below. - Detailed
Error boolMessages Enabled - Should
Detailed error messages
be enabled on this App Service? Defaults tofalse
. - Failed
Request boolTracing Enabled - Should
Failed request tracing
be enabled on this App Service? Defaults tofalse
. - Http
Logs AppService Logs Http Logs - An
http_logs
block as defined below.
- Application
Logs AppService Logs Application Logs - An
application_logs
block as defined below. - Detailed
Error boolMessages Enabled - Should
Detailed error messages
be enabled on this App Service? Defaults tofalse
. - Failed
Request boolTracing Enabled - Should
Failed request tracing
be enabled on this App Service? Defaults tofalse
. - Http
Logs AppService Logs Http Logs - An
http_logs
block as defined below.
- application
Logs AppService Logs Application Logs - An
application_logs
block as defined below. - detailed
Error BooleanMessages Enabled - Should
Detailed error messages
be enabled on this App Service? Defaults tofalse
. - failed
Request BooleanTracing Enabled - Should
Failed request tracing
be enabled on this App Service? Defaults tofalse
. - http
Logs AppService Logs Http Logs - An
http_logs
block as defined below.
- application
Logs AppService Logs Application Logs - An
application_logs
block as defined below. - detailed
Error booleanMessages Enabled - Should
Detailed error messages
be enabled on this App Service? Defaults tofalse
. - failed
Request booleanTracing Enabled - Should
Failed request tracing
be enabled on this App Service? Defaults tofalse
. - http
Logs AppService Logs Http Logs - An
http_logs
block as defined below.
- application_
logs AppService Logs Application Logs - An
application_logs
block as defined below. - detailed_
error_ boolmessages_ enabled - Should
Detailed error messages
be enabled on this App Service? Defaults tofalse
. - failed_
request_ booltracing_ enabled - Should
Failed request tracing
be enabled on this App Service? Defaults tofalse
. - http_
logs AppService Logs Http Logs - An
http_logs
block as defined below.
- application
Logs Property Map - An
application_logs
block as defined below. - detailed
Error BooleanMessages Enabled - Should
Detailed error messages
be enabled on this App Service? Defaults tofalse
. - failed
Request BooleanTracing Enabled - Should
Failed request tracing
be enabled on this App Service? Defaults tofalse
. - http
Logs Property Map - An
http_logs
block as defined below.
AppServiceLogsApplicationLogs, AppServiceLogsApplicationLogsArgs
- Azure
Blob AppStorage Service Logs Application Logs Azure Blob Storage - An
azure_blob_storage
block as defined below. - File
System stringLevel - Log level for filesystem based logging. Supported values are
Error
,Information
,Verbose
,Warning
andOff
. Defaults toOff
.
- Azure
Blob AppStorage Service Logs Application Logs Azure Blob Storage - An
azure_blob_storage
block as defined below. - File
System stringLevel - Log level for filesystem based logging. Supported values are
Error
,Information
,Verbose
,Warning
andOff
. Defaults toOff
.
- azure
Blob AppStorage Service Logs Application Logs Azure Blob Storage - An
azure_blob_storage
block as defined below. - file
System StringLevel - Log level for filesystem based logging. Supported values are
Error
,Information
,Verbose
,Warning
andOff
. Defaults toOff
.
- azure
Blob AppStorage Service Logs Application Logs Azure Blob Storage - An
azure_blob_storage
block as defined below. - file
System stringLevel - Log level for filesystem based logging. Supported values are
Error
,Information
,Verbose
,Warning
andOff
. Defaults toOff
.
- azure_
blob_ Appstorage Service Logs Application Logs Azure Blob Storage - An
azure_blob_storage
block as defined below. - file_
system_ strlevel - Log level for filesystem based logging. Supported values are
Error
,Information
,Verbose
,Warning
andOff
. Defaults toOff
.
- azure
Blob Property MapStorage - An
azure_blob_storage
block as defined below. - file
System StringLevel - Log level for filesystem based logging. Supported values are
Error
,Information
,Verbose
,Warning
andOff
. Defaults toOff
.
AppServiceLogsApplicationLogsAzureBlobStorage, AppServiceLogsApplicationLogsAzureBlobStorageArgs
- Level string
- The level at which to log. Possible values include
Error
,Warning
,Information
,Verbose
andOff
. NOTE: this field is not available forhttp_logs
- Retention
In intDays - The number of days to retain logs for.
- Sas
Url 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
andOff
. NOTE: this field is not available forhttp_logs
- Retention
In intDays - The number of days to retain logs for.
- Sas
Url 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
andOff
. NOTE: this field is not available forhttp_logs
- retention
In IntegerDays - The number of days to retain logs for.
- sas
Url 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
andOff
. NOTE: this field is not available forhttp_logs
- retention
In numberDays - The number of days to retain logs for.
- sas
Url 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
andOff
. NOTE: this field is not available forhttp_logs
- retention_
in_ intdays - 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
andOff
. NOTE: this field is not available forhttp_logs
- retention
In NumberDays - The number of days to retain logs for.
- sas
Url String - The URL to the storage container with a shared access signature token appended.
AppServiceLogsHttpLogs, AppServiceLogsHttpLogsArgs
- Azure
Blob AppStorage Service Logs Http Logs Azure Blob Storage - An
azure_blob_storage
block as defined below. - File
System AppService Logs Http Logs File System - A
file_system
block as defined below.
- Azure
Blob AppStorage Service Logs Http Logs Azure Blob Storage - An
azure_blob_storage
block as defined below. - File
System AppService Logs Http Logs File System - A
file_system
block as defined below.
- azure
Blob AppStorage Service Logs Http Logs Azure Blob Storage - An
azure_blob_storage
block as defined below. - file
System AppService Logs Http Logs File System - A
file_system
block as defined below.
- azure
Blob AppStorage Service Logs Http Logs Azure Blob Storage - An
azure_blob_storage
block as defined below. - file
System AppService Logs Http Logs File System - A
file_system
block as defined below.
- azure_
blob_ Appstorage Service Logs Http Logs Azure Blob Storage - An
azure_blob_storage
block as defined below. - file_
system AppService Logs Http Logs File System - A
file_system
block as defined below.
- azure
Blob Property MapStorage - An
azure_blob_storage
block as defined below. - file
System Property Map - A
file_system
block as defined below.
AppServiceLogsHttpLogsAzureBlobStorage, AppServiceLogsHttpLogsAzureBlobStorageArgs
- Retention
In intDays - The number of days to retain logs for.
- Sas
Url string - The URL to the storage container with a shared access signature token appended.
- Retention
In intDays - The number of days to retain logs for.
- Sas
Url string - The URL to the storage container with a shared access signature token appended.
- retention
In IntegerDays - The number of days to retain logs for.
- sas
Url String - The URL to the storage container with a shared access signature token appended.
- retention
In numberDays - The number of days to retain logs for.
- sas
Url string - The URL to the storage container with a shared access signature token appended.
- retention_
in_ intdays - The number of days to retain logs for.
- sas_
url str - The URL to the storage container with a shared access signature token appended.
- retention
In NumberDays - The number of days to retain logs for.
- sas
Url String - The URL to the storage container with a shared access signature token appended.
AppServiceLogsHttpLogsFileSystem, AppServiceLogsHttpLogsFileSystemArgs
- Retention
In intDays - The number of days to retain logs for.
- Retention
In intMb - The maximum size in megabytes that HTTP log files can use before being removed.
- Retention
In intDays - The number of days to retain logs for.
- Retention
In intMb - The maximum size in megabytes that HTTP log files can use before being removed.
- retention
In IntegerDays - The number of days to retain logs for.
- retention
In IntegerMb - The maximum size in megabytes that HTTP log files can use before being removed.
- retention
In numberDays - The number of days to retain logs for.
- retention
In numberMb - The maximum size in megabytes that HTTP log files can use before being removed.
- retention_
in_ intdays - The number of days to retain logs for.
- retention_
in_ intmb - The maximum size in megabytes that HTTP log files can use before being removed.
- retention
In NumberDays - The number of days to retain logs for.
- retention
In NumberMb - The maximum size in megabytes that HTTP log files can use before being removed.
AppServiceSiteConfig, AppServiceSiteConfigArgs
- Acr
Use boolManaged Identity Credentials - Are Managed Identity Credentials used for Azure Container Registry pull
- Acr
User stringManaged Identity Client Id If using User Managed Identity, the User Managed Identity Client Id
NOTE: When using User Managed Identity with Azure Container Registry the Identity will need to have the ACRPull role assigned
- Always
On bool Should the app be loaded at all times? Defaults to
false
.NOTE: when using an App Service Plan in the
Free
orShared
Tiersalways_on
must be set tofalse
.- App
Command stringLine - App command line to launch, e.g.
/sbin/myserver -b 0.0.0.0
. - Auto
Swap stringSlot Name - The name of the slot to automatically swap to during deployment
- Cors
App
Service Site Config Cors - A
cors
block as defined below. - Default
Documents List<string> - The ordering of default documents to load, if an address isn't specified.
- Dotnet
Framework stringVersion - 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
andv6.0
. For more information on which .NET CLR version to use based on the .NET framework you're targeting - please see this table. Defaults tov4.0
. - Ftps
State string - State of FTP / FTPS service for this App Service. Possible values include:
AllAllowed
,FtpsOnly
andDisabled
. - Health
Check stringPath - 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
. - Ip
Restrictions List<AppService Site Config Ip Restriction> A list of objects representing ip restrictions as defined below.
NOTE User has to explicitly set
ip_restriction
to empty slice ([]
) to remove it.- Java
Container string - The Java Container to use. If specified
java_version
andjava_container_version
must also be specified. Possible values areJAVA
,JETTY
, andTOMCAT
. - Java
Container stringVersion - The version of the Java Container to use. If specified
java_version
andjava_container
must also be specified. - Java
Version string - The version of Java to use. If specified
java_container
andjava_container_version
must also be specified. Possible values are1.7
,1.8
and11
and their specific versions - except for Java 11 (e.g.1.7.0_80
,1.8.0_181
,11
) - Linux
Fx stringVersion 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")}
).NOTE: To set this property the App Service Plan to which the App belongs must be configured with
kind = "Linux"
, andreserved = true
or the API will reject any value supplied.- Local
Mysql boolEnabled Is "MySQL In App" Enabled? This runs a local MySQL instance with your app and shares resources from the App Service plan.
NOTE: MySQL In App is not intended for production environments and will not scale beyond a single instance. Instead you may wish to use Azure Database for MySQL.
- Managed
Pipeline stringMode - The Managed Pipeline Mode. Possible values are
Integrated
andClassic
. Defaults toIntegrated
. - Min
Tls stringVersion - The minimum supported TLS version for the app service. Possible values are
1.0
,1.1
, and1.2
. Defaults to1.2
for new app services. - Number
Of intWorkers - The scaled number of workers (for per site scaling) of this App Service. Requires that
per_site_scaling
is enabled on theazure.appservice.Plan
. For more information - please see Microsoft documentation on high-density hosting. - Php
Version 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
and7.4
. - Python
Version string - The version of Python to use in this App Service. Possible values are
2.7
and3.4
. - Remote
Debugging boolEnabled - Is Remote Debugging Enabled? Defaults to
false
. - Remote
Debugging stringVersion - Which version of Visual Studio should the Remote Debugger be compatible with? Possible values are
VS2017
,VS2019
,VS2022
. - Scm
Ip List<AppRestrictions Service Site Config Scm Ip Restriction> A list of
scm_ip_restriction
objects representing IP restrictions as defined below.NOTE User has to explicitly set
scm_ip_restriction
to empty slice ([]
) to remove it.- Scm
Type 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
, andVSTSRM
- Scm
Use boolMain Ip Restriction IP security restrictions for scm to use main. Defaults to
false
.NOTE Any
scm_ip_restriction
blocks configured are ignored by the service whenscm_use_main_ip_restriction
is set totrue
. Any scm restrictions will become active if this is subsequently set tofalse
or removed.- Use32Bit
Worker boolProcess Should the App Service run in 32 bit mode, rather than 64 bit mode?
NOTE: when using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- Vnet
Route boolAll Enabled - Websockets
Enabled bool - Should WebSockets be enabled?
- Windows
Fx stringVersion - The Windows Docker container image (
DOCKER|<user/image:tag>
)
- Acr
Use boolManaged Identity Credentials - Are Managed Identity Credentials used for Azure Container Registry pull
- Acr
User stringManaged Identity Client Id If using User Managed Identity, the User Managed Identity Client Id
NOTE: When using User Managed Identity with Azure Container Registry the Identity will need to have the ACRPull role assigned
- Always
On bool Should the app be loaded at all times? Defaults to
false
.NOTE: when using an App Service Plan in the
Free
orShared
Tiersalways_on
must be set tofalse
.- App
Command stringLine - App command line to launch, e.g.
/sbin/myserver -b 0.0.0.0
. - Auto
Swap stringSlot Name - The name of the slot to automatically swap to during deployment
- Cors
App
Service Site Config Cors - A
cors
block as defined below. - Default
Documents []string - The ordering of default documents to load, if an address isn't specified.
- Dotnet
Framework stringVersion - 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
andv6.0
. For more information on which .NET CLR version to use based on the .NET framework you're targeting - please see this table. Defaults tov4.0
. - Ftps
State string - State of FTP / FTPS service for this App Service. Possible values include:
AllAllowed
,FtpsOnly
andDisabled
. - Health
Check stringPath - 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
. - Ip
Restrictions []AppService Site Config Ip Restriction A list of objects representing ip restrictions as defined below.
NOTE User has to explicitly set
ip_restriction
to empty slice ([]
) to remove it.- Java
Container string - The Java Container to use. If specified
java_version
andjava_container_version
must also be specified. Possible values areJAVA
,JETTY
, andTOMCAT
. - Java
Container stringVersion - The version of the Java Container to use. If specified
java_version
andjava_container
must also be specified. - Java
Version string - The version of Java to use. If specified
java_container
andjava_container_version
must also be specified. Possible values are1.7
,1.8
and11
and their specific versions - except for Java 11 (e.g.1.7.0_80
,1.8.0_181
,11
) - Linux
Fx stringVersion 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")}
).NOTE: To set this property the App Service Plan to which the App belongs must be configured with
kind = "Linux"
, andreserved = true
or the API will reject any value supplied.- Local
Mysql boolEnabled Is "MySQL In App" Enabled? This runs a local MySQL instance with your app and shares resources from the App Service plan.
NOTE: MySQL In App is not intended for production environments and will not scale beyond a single instance. Instead you may wish to use Azure Database for MySQL.
- Managed
Pipeline stringMode - The Managed Pipeline Mode. Possible values are
Integrated
andClassic
. Defaults toIntegrated
. - Min
Tls stringVersion - The minimum supported TLS version for the app service. Possible values are
1.0
,1.1
, and1.2
. Defaults to1.2
for new app services. - Number
Of intWorkers - The scaled number of workers (for per site scaling) of this App Service. Requires that
per_site_scaling
is enabled on theazure.appservice.Plan
. For more information - please see Microsoft documentation on high-density hosting. - Php
Version 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
and7.4
. - Python
Version string - The version of Python to use in this App Service. Possible values are
2.7
and3.4
. - Remote
Debugging boolEnabled - Is Remote Debugging Enabled? Defaults to
false
. - Remote
Debugging stringVersion - Which version of Visual Studio should the Remote Debugger be compatible with? Possible values are
VS2017
,VS2019
,VS2022
. - Scm
Ip []AppRestrictions Service Site Config Scm Ip Restriction A list of
scm_ip_restriction
objects representing IP restrictions as defined below.NOTE User has to explicitly set
scm_ip_restriction
to empty slice ([]
) to remove it.- Scm
Type 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
, andVSTSRM
- Scm
Use boolMain Ip Restriction IP security restrictions for scm to use main. Defaults to
false
.NOTE Any
scm_ip_restriction
blocks configured are ignored by the service whenscm_use_main_ip_restriction
is set totrue
. Any scm restrictions will become active if this is subsequently set tofalse
or removed.- Use32Bit
Worker boolProcess Should the App Service run in 32 bit mode, rather than 64 bit mode?
NOTE: when using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- Vnet
Route boolAll Enabled - Websockets
Enabled bool - Should WebSockets be enabled?
- Windows
Fx stringVersion - The Windows Docker container image (
DOCKER|<user/image:tag>
)
- acr
Use BooleanManaged Identity Credentials - Are Managed Identity Credentials used for Azure Container Registry pull
- acr
User StringManaged Identity Client Id If using User Managed Identity, the User Managed Identity Client Id
NOTE: When using User Managed Identity with Azure Container Registry the Identity will need to have the ACRPull role assigned
- always
On Boolean Should the app be loaded at all times? Defaults to
false
.NOTE: when using an App Service Plan in the
Free
orShared
Tiersalways_on
must be set tofalse
.- app
Command StringLine - App command line to launch, e.g.
/sbin/myserver -b 0.0.0.0
. - auto
Swap StringSlot Name - The name of the slot to automatically swap to during deployment
- cors
App
Service Site Config Cors - A
cors
block as defined below. - default
Documents List<String> - The ordering of default documents to load, if an address isn't specified.
- dotnet
Framework StringVersion - 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
andv6.0
. For more information on which .NET CLR version to use based on the .NET framework you're targeting - please see this table. Defaults tov4.0
. - ftps
State String - State of FTP / FTPS service for this App Service. Possible values include:
AllAllowed
,FtpsOnly
andDisabled
. - health
Check StringPath - 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
. - ip
Restrictions List<AppService Site Config Ip Restriction> A list of objects representing ip restrictions as defined below.
NOTE User has to explicitly set
ip_restriction
to empty slice ([]
) to remove it.- java
Container String - The Java Container to use. If specified
java_version
andjava_container_version
must also be specified. Possible values areJAVA
,JETTY
, andTOMCAT
. - java
Container StringVersion - The version of the Java Container to use. If specified
java_version
andjava_container
must also be specified. - java
Version String - The version of Java to use. If specified
java_container
andjava_container_version
must also be specified. Possible values are1.7
,1.8
and11
and their specific versions - except for Java 11 (e.g.1.7.0_80
,1.8.0_181
,11
) - linux
Fx StringVersion 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")}
).NOTE: To set this property the App Service Plan to which the App belongs must be configured with
kind = "Linux"
, andreserved = true
or the API will reject any value supplied.- local
Mysql BooleanEnabled Is "MySQL In App" Enabled? This runs a local MySQL instance with your app and shares resources from the App Service plan.
NOTE: MySQL In App is not intended for production environments and will not scale beyond a single instance. Instead you may wish to use Azure Database for MySQL.
- managed
Pipeline StringMode - The Managed Pipeline Mode. Possible values are
Integrated
andClassic
. Defaults toIntegrated
. - min
Tls StringVersion - The minimum supported TLS version for the app service. Possible values are
1.0
,1.1
, and1.2
. Defaults to1.2
for new app services. - number
Of IntegerWorkers - The scaled number of workers (for per site scaling) of this App Service. Requires that
per_site_scaling
is enabled on theazure.appservice.Plan
. For more information - please see Microsoft documentation on high-density hosting. - php
Version 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
and7.4
. - python
Version String - The version of Python to use in this App Service. Possible values are
2.7
and3.4
. - remote
Debugging BooleanEnabled - Is Remote Debugging Enabled? Defaults to
false
. - remote
Debugging StringVersion - Which version of Visual Studio should the Remote Debugger be compatible with? Possible values are
VS2017
,VS2019
,VS2022
. - scm
Ip List<AppRestrictions Service Site Config Scm Ip Restriction> A list of
scm_ip_restriction
objects representing IP restrictions as defined below.NOTE User has to explicitly set
scm_ip_restriction
to empty slice ([]
) to remove it.- scm
Type 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
, andVSTSRM
- scm
Use BooleanMain Ip Restriction IP security restrictions for scm to use main. Defaults to
false
.NOTE Any
scm_ip_restriction
blocks configured are ignored by the service whenscm_use_main_ip_restriction
is set totrue
. Any scm restrictions will become active if this is subsequently set tofalse
or removed.- use32Bit
Worker BooleanProcess Should the App Service run in 32 bit mode, rather than 64 bit mode?
NOTE: when using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- vnet
Route BooleanAll Enabled - websockets
Enabled Boolean - Should WebSockets be enabled?
- windows
Fx StringVersion - The Windows Docker container image (
DOCKER|<user/image:tag>
)
- acr
Use booleanManaged Identity Credentials - Are Managed Identity Credentials used for Azure Container Registry pull
- acr
User stringManaged Identity Client Id If using User Managed Identity, the User Managed Identity Client Id
NOTE: When using User Managed Identity with Azure Container Registry the Identity will need to have the ACRPull role assigned
- always
On boolean Should the app be loaded at all times? Defaults to
false
.NOTE: when using an App Service Plan in the
Free
orShared
Tiersalways_on
must be set tofalse
.- app
Command stringLine - App command line to launch, e.g.
/sbin/myserver -b 0.0.0.0
. - auto
Swap stringSlot Name - The name of the slot to automatically swap to during deployment
- cors
App
Service Site Config Cors - A
cors
block as defined below. - default
Documents string[] - The ordering of default documents to load, if an address isn't specified.
- dotnet
Framework stringVersion - 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
andv6.0
. For more information on which .NET CLR version to use based on the .NET framework you're targeting - please see this table. Defaults tov4.0
. - ftps
State string - State of FTP / FTPS service for this App Service. Possible values include:
AllAllowed
,FtpsOnly
andDisabled
. - health
Check stringPath - 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
. - ip
Restrictions AppService Site Config Ip Restriction[] A list of objects representing ip restrictions as defined below.
NOTE User has to explicitly set
ip_restriction
to empty slice ([]
) to remove it.- java
Container string - The Java Container to use. If specified
java_version
andjava_container_version
must also be specified. Possible values areJAVA
,JETTY
, andTOMCAT
. - java
Container stringVersion - The version of the Java Container to use. If specified
java_version
andjava_container
must also be specified. - java
Version string - The version of Java to use. If specified
java_container
andjava_container_version
must also be specified. Possible values are1.7
,1.8
and11
and their specific versions - except for Java 11 (e.g.1.7.0_80
,1.8.0_181
,11
) - linux
Fx stringVersion 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")}
).NOTE: To set this property the App Service Plan to which the App belongs must be configured with
kind = "Linux"
, andreserved = true
or the API will reject any value supplied.- local
Mysql booleanEnabled Is "MySQL In App" Enabled? This runs a local MySQL instance with your app and shares resources from the App Service plan.
NOTE: MySQL In App is not intended for production environments and will not scale beyond a single instance. Instead you may wish to use Azure Database for MySQL.
- managed
Pipeline stringMode - The Managed Pipeline Mode. Possible values are
Integrated
andClassic
. Defaults toIntegrated
. - min
Tls stringVersion - The minimum supported TLS version for the app service. Possible values are
1.0
,1.1
, and1.2
. Defaults to1.2
for new app services. - number
Of numberWorkers - The scaled number of workers (for per site scaling) of this App Service. Requires that
per_site_scaling
is enabled on theazure.appservice.Plan
. For more information - please see Microsoft documentation on high-density hosting. - php
Version 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
and7.4
. - python
Version string - The version of Python to use in this App Service. Possible values are
2.7
and3.4
. - remote
Debugging booleanEnabled - Is Remote Debugging Enabled? Defaults to
false
. - remote
Debugging stringVersion - Which version of Visual Studio should the Remote Debugger be compatible with? Possible values are
VS2017
,VS2019
,VS2022
. - scm
Ip AppRestrictions Service Site Config Scm Ip Restriction[] A list of
scm_ip_restriction
objects representing IP restrictions as defined below.NOTE User has to explicitly set
scm_ip_restriction
to empty slice ([]
) to remove it.- scm
Type 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
, andVSTSRM
- scm
Use booleanMain Ip Restriction IP security restrictions for scm to use main. Defaults to
false
.NOTE Any
scm_ip_restriction
blocks configured are ignored by the service whenscm_use_main_ip_restriction
is set totrue
. Any scm restrictions will become active if this is subsequently set tofalse
or removed.- use32Bit
Worker booleanProcess Should the App Service run in 32 bit mode, rather than 64 bit mode?
NOTE: when using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- vnet
Route booleanAll Enabled - websockets
Enabled boolean - Should WebSockets be enabled?
- windows
Fx stringVersion - The Windows Docker container image (
DOCKER|<user/image:tag>
)
- acr_
use_ boolmanaged_ identity_ credentials - Are Managed Identity Credentials used for Azure Container Registry pull
- acr_
user_ strmanaged_ identity_ client_ id If using User Managed Identity, the User Managed Identity Client Id
NOTE: When using User Managed Identity with Azure Container Registry the Identity will need to have the ACRPull role assigned
- always_
on bool Should the app be loaded at all times? Defaults to
false
.NOTE: when using an App Service Plan in the
Free
orShared
Tiersalways_on
must be set tofalse
.- app_
command_ strline - App command line to launch, e.g.
/sbin/myserver -b 0.0.0.0
. - auto_
swap_ strslot_ name - The name of the slot to automatically swap to during deployment
- cors
App
Service Site Config Cors - 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_ strversion - 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
andv6.0
. For more information on which .NET CLR version to use based on the .NET framework you're targeting - please see this table. Defaults tov4.0
. - ftps_
state str - State of FTP / FTPS service for this App Service. Possible values include:
AllAllowed
,FtpsOnly
andDisabled
. - health_
check_ strpath - 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[AppService Site Config Ip Restriction] A list of objects representing ip restrictions as defined below.
NOTE User has to explicitly set
ip_restriction
to empty slice ([]
) to remove it.- java_
container str - The Java Container to use. If specified
java_version
andjava_container_version
must also be specified. Possible values areJAVA
,JETTY
, andTOMCAT
. - java_
container_ strversion - The version of the Java Container to use. If specified
java_version
andjava_container
must also be specified. - java_
version str - The version of Java to use. If specified
java_container
andjava_container_version
must also be specified. Possible values are1.7
,1.8
and11
and their specific versions - except for Java 11 (e.g.1.7.0_80
,1.8.0_181
,11
) - linux_
fx_ strversion 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")}
).NOTE: To set this property the App Service Plan to which the App belongs must be configured with
kind = "Linux"
, andreserved = true
or the API will reject any value supplied.- local_
mysql_ boolenabled Is "MySQL In App" Enabled? This runs a local MySQL instance with your app and shares resources from the App Service plan.
NOTE: MySQL In App is not intended for production environments and will not scale beyond a single instance. Instead you may wish to use Azure Database for MySQL.
- managed_
pipeline_ strmode - The Managed Pipeline Mode. Possible values are
Integrated
andClassic
. Defaults toIntegrated
. - min_
tls_ strversion - The minimum supported TLS version for the app service. Possible values are
1.0
,1.1
, and1.2
. Defaults to1.2
for new app services. - number_
of_ intworkers - The scaled number of workers (for per site scaling) of this App Service. Requires that
per_site_scaling
is enabled on theazure.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
and7.4
. - python_
version str - The version of Python to use in this App Service. Possible values are
2.7
and3.4
. - remote_
debugging_ boolenabled - Is Remote Debugging Enabled? Defaults to
false
. - remote_
debugging_ strversion - Which version of Visual Studio should the Remote Debugger be compatible with? Possible values are
VS2017
,VS2019
,VS2022
. - scm_
ip_ Sequence[Apprestrictions Service Site Config Scm Ip Restriction] A list of
scm_ip_restriction
objects representing IP restrictions as defined below.NOTE User has to explicitly set
scm_ip_restriction
to empty slice ([]
) to remove it.- 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
, andVSTSRM
- scm_
use_ boolmain_ ip_ restriction IP security restrictions for scm to use main. Defaults to
false
.NOTE Any
scm_ip_restriction
blocks configured are ignored by the service whenscm_use_main_ip_restriction
is set totrue
. Any scm restrictions will become active if this is subsequently set tofalse
or removed.- use32_
bit_ boolworker_ process Should the App Service run in 32 bit mode, rather than 64 bit mode?
NOTE: when using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- vnet_
route_ boolall_ enabled - websockets_
enabled bool - Should WebSockets be enabled?
- windows_
fx_ strversion - The Windows Docker container image (
DOCKER|<user/image:tag>
)
- acr
Use BooleanManaged Identity Credentials - Are Managed Identity Credentials used for Azure Container Registry pull
- acr
User StringManaged Identity Client Id If using User Managed Identity, the User Managed Identity Client Id
NOTE: When using User Managed Identity with Azure Container Registry the Identity will need to have the ACRPull role assigned
- always
On Boolean Should the app be loaded at all times? Defaults to
false
.NOTE: when using an App Service Plan in the
Free
orShared
Tiersalways_on
must be set tofalse
.- app
Command StringLine - App command line to launch, e.g.
/sbin/myserver -b 0.0.0.0
. - auto
Swap StringSlot Name - The name of the slot to automatically swap to during deployment
- cors Property Map
- A
cors
block as defined below. - default
Documents List<String> - The ordering of default documents to load, if an address isn't specified.
- dotnet
Framework StringVersion - 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
andv6.0
. For more information on which .NET CLR version to use based on the .NET framework you're targeting - please see this table. Defaults tov4.0
. - ftps
State String - State of FTP / FTPS service for this App Service. Possible values include:
AllAllowed
,FtpsOnly
andDisabled
. - health
Check StringPath - 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
. - ip
Restrictions List<Property Map> A list of objects representing ip restrictions as defined below.
NOTE User has to explicitly set
ip_restriction
to empty slice ([]
) to remove it.- java
Container String - The Java Container to use. If specified
java_version
andjava_container_version
must also be specified. Possible values areJAVA
,JETTY
, andTOMCAT
. - java
Container StringVersion - The version of the Java Container to use. If specified
java_version
andjava_container
must also be specified. - java
Version String - The version of Java to use. If specified
java_container
andjava_container_version
must also be specified. Possible values are1.7
,1.8
and11
and their specific versions - except for Java 11 (e.g.1.7.0_80
,1.8.0_181
,11
) - linux
Fx StringVersion 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")}
).NOTE: To set this property the App Service Plan to which the App belongs must be configured with
kind = "Linux"
, andreserved = true
or the API will reject any value supplied.- local
Mysql BooleanEnabled Is "MySQL In App" Enabled? This runs a local MySQL instance with your app and shares resources from the App Service plan.
NOTE: MySQL In App is not intended for production environments and will not scale beyond a single instance. Instead you may wish to use Azure Database for MySQL.
- managed
Pipeline StringMode - The Managed Pipeline Mode. Possible values are
Integrated
andClassic
. Defaults toIntegrated
. - min
Tls StringVersion - The minimum supported TLS version for the app service. Possible values are
1.0
,1.1
, and1.2
. Defaults to1.2
for new app services. - number
Of NumberWorkers - The scaled number of workers (for per site scaling) of this App Service. Requires that
per_site_scaling
is enabled on theazure.appservice.Plan
. For more information - please see Microsoft documentation on high-density hosting. - php
Version 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
and7.4
. - python
Version String - The version of Python to use in this App Service. Possible values are
2.7
and3.4
. - remote
Debugging BooleanEnabled - Is Remote Debugging Enabled? Defaults to
false
. - remote
Debugging StringVersion - Which version of Visual Studio should the Remote Debugger be compatible with? Possible values are
VS2017
,VS2019
,VS2022
. - scm
Ip List<Property Map>Restrictions A list of
scm_ip_restriction
objects representing IP restrictions as defined below.NOTE User has to explicitly set
scm_ip_restriction
to empty slice ([]
) to remove it.- scm
Type 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
, andVSTSRM
- scm
Use BooleanMain Ip Restriction IP security restrictions for scm to use main. Defaults to
false
.NOTE Any
scm_ip_restriction
blocks configured are ignored by the service whenscm_use_main_ip_restriction
is set totrue
. Any scm restrictions will become active if this is subsequently set tofalse
or removed.- use32Bit
Worker BooleanProcess Should the App Service run in 32 bit mode, rather than 64 bit mode?
NOTE: when using an App Service Plan in the
Free
orShared
Tiersuse_32_bit_worker_process
must be set totrue
.- vnet
Route BooleanAll Enabled - websockets
Enabled Boolean - Should WebSockets be enabled?
- windows
Fx StringVersion - The Windows Docker container image (
DOCKER|<user/image:tag>
)
AppServiceSiteConfigCors, AppServiceSiteConfigCorsArgs
- Allowed
Origins List<string> - 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?
- Allowed
Origins []string - 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?
- allowed
Origins List<String> - A list of origins which should be able to make cross-origin calls.
*
can be used to allow all calls. - support
Credentials Boolean - Are credentials supported?
- allowed
Origins string[] - A list of origins which should be able to make cross-origin calls.
*
can be used to allow all calls. - support
Credentials 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?
- allowed
Origins List<String> - A list of origins which should be able to make cross-origin calls.
*
can be used to allow all calls. - support
Credentials Boolean - Are credentials supported?
AppServiceSiteConfigIpRestriction, AppServiceSiteConfigIpRestrictionArgs
- Action string
- Does this restriction
Allow
orDeny
access for this IP range. Defaults toAllow
. - Headers
App
Service Site Config Ip Restriction Headers - The
headers
block for this specificip_restriction
as defined below. - Ip
Address 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.
- Service
Tag string - The Service Tag used for this IP Restriction.
- Virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
- Action string
- Does this restriction
Allow
orDeny
access for this IP range. Defaults toAllow
. - Headers
App
Service Site Config Ip Restriction Headers - The
headers
block for this specificip_restriction
as defined below. - Ip
Address 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.
- Service
Tag string - The Service Tag used for this IP Restriction.
- Virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
- action String
- Does this restriction
Allow
orDeny
access for this IP range. Defaults toAllow
. - headers
App
Service Site Config Ip Restriction Headers - The
headers
block for this specificip_restriction
as defined below. - ip
Address 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.
- service
Tag String - The Service Tag used for this IP Restriction.
- virtual
Network StringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
- action string
- Does this restriction
Allow
orDeny
access for this IP range. Defaults toAllow
. - headers
App
Service Site Config Ip Restriction Headers - The
headers
block for this specificip_restriction
as defined below. - ip
Address 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.
- service
Tag string - The Service Tag used for this IP Restriction.
- virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
- action str
- Does this restriction
Allow
orDeny
access for this IP range. Defaults toAllow
. - headers
App
Service Site Config Ip Restriction Headers - The
headers
block for this specificip_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_ strsubnet_ id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
- action String
- Does this restriction
Allow
orDeny
access for this IP range. Defaults toAllow
. - headers Property Map
- The
headers
block for this specificip_restriction
as defined below. - ip
Address 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.
- service
Tag String - The Service Tag used for this IP Restriction.
- virtual
Network StringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
AppServiceSiteConfigIpRestrictionHeaders, AppServiceSiteConfigIpRestrictionHeadersArgs
- XAzure
Fdids List<string> - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- XFd
Health stringProbe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- XForwarded
Fors List<string> - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- XForwarded
Hosts List<string> - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
- XAzure
Fdids []string - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- XFd
Health stringProbe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- XForwarded
Fors []string - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- XForwarded
Hosts []string - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
- x
Azure List<String>Fdids - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- x
Fd StringHealth Probe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- x
Forwarded List<String>Fors - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- x
Forwarded List<String>Hosts - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
- x
Azure string[]Fdids - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- x
Fd stringHealth Probe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- x
Forwarded string[]Fors - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- x
Forwarded string[]Hosts - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
- x_
azure_ Sequence[str]fdids - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- x_
fd_ strhealth_ probe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- x_
forwarded_ Sequence[str]fors - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- x_
forwarded_ Sequence[str]hosts - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
- x
Azure List<String>Fdids - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- x
Fd StringHealth Probe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- x
Forwarded List<String>Fors - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- x
Forwarded List<String>Hosts - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
AppServiceSiteConfigScmIpRestriction, AppServiceSiteConfigScmIpRestrictionArgs
- Action string
- Allow or Deny access for this IP range. Defaults to
Allow
. - Headers
App
Service Site Config Scm Ip Restriction Headers - The
headers
block for this specificscm_ip_restriction
as defined below. - Ip
Address 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.
- Service
Tag string - The Service Tag used for this IP Restriction.
- Virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
- Action string
- Allow or Deny access for this IP range. Defaults to
Allow
. - Headers
App
Service Site Config Scm Ip Restriction Headers - The
headers
block for this specificscm_ip_restriction
as defined below. - Ip
Address 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.
- Service
Tag string - The Service Tag used for this IP Restriction.
- Virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
- action String
- Allow or Deny access for this IP range. Defaults to
Allow
. - headers
App
Service Site Config Scm Ip Restriction Headers - The
headers
block for this specificscm_ip_restriction
as defined below. - ip
Address 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.
- service
Tag String - The Service Tag used for this IP Restriction.
- virtual
Network StringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
- action string
- Allow or Deny access for this IP range. Defaults to
Allow
. - headers
App
Service Site Config Scm Ip Restriction Headers - The
headers
block for this specificscm_ip_restriction
as defined below. - ip
Address 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.
- service
Tag string - The Service Tag used for this IP Restriction.
- virtual
Network stringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
- action str
- Allow or Deny access for this IP range. Defaults to
Allow
. - headers
App
Service Site Config Scm Ip Restriction Headers - The
headers
block for this specificscm_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_ strsubnet_ id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
- action String
- Allow or Deny access for this IP range. Defaults to
Allow
. - headers Property Map
- The
headers
block for this specificscm_ip_restriction
as defined below. - ip
Address 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.
- service
Tag String - The Service Tag used for this IP Restriction.
- virtual
Network StringSubnet Id The Virtual Network Subnet ID used for this IP Restriction.
NOTE: One of either
ip_address
,service_tag
orvirtual_network_subnet_id
must be specified
AppServiceSiteConfigScmIpRestrictionHeaders, AppServiceSiteConfigScmIpRestrictionHeadersArgs
- XAzure
Fdids List<string> - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- XFd
Health stringProbe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- XForwarded
Fors List<string> - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- XForwarded
Hosts List<string> - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
- XAzure
Fdids []string - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- XFd
Health stringProbe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- XForwarded
Fors []string - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- XForwarded
Hosts []string - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
- x
Azure List<String>Fdids - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- x
Fd StringHealth Probe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- x
Forwarded List<String>Fors - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- x
Forwarded List<String>Hosts - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
- x
Azure string[]Fdids - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- x
Fd stringHealth Probe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- x
Forwarded string[]Fors - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- x
Forwarded string[]Hosts - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
- x_
azure_ Sequence[str]fdids - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- x_
fd_ strhealth_ probe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- x_
forwarded_ Sequence[str]fors - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- x_
forwarded_ Sequence[str]hosts - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
- x
Azure List<String>Fdids - A list of allowed Azure FrontDoor IDs in UUID notation with a maximum of 8.
- x
Fd StringHealth Probe - A list to allow the Azure FrontDoor health probe header. Only allowed value is "1".
- x
Forwarded List<String>Fors - A list of allowed 'X-Forwarded-For' IPs in CIDR notation with a maximum of 8
- x
Forwarded List<String>Hosts - A list of allowed 'X-Forwarded-Host' domains with a maximum of 8.
AppServiceSiteCredential, AppServiceSiteCredentialArgs
AppServiceSourceControl, AppServiceSourceControlArgs
- Branch string
- 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 string - 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'.
- Manual
Integration bool - Limits to manual integration. Defaults to
false
if not specified. - Repo
Url string - 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'.
- manual
Integration Boolean - Limits to manual integration. Defaults to
false
if not specified. - repo
Url String - The URL of the source code repository.
- rollback
Enabled Boolean - Enable roll-back for the repository. Defaults to
false
if not specified. - use
Mercurial Boolean - Use Mercurial if
true
, otherwise uses Git.
- branch string
- The branch of the remote repository to use. Defaults to 'master'.
- manual
Integration boolean - Limits to manual integration. Defaults to
false
if not specified. - repo
Url string - The URL of the source code repository.
- rollback
Enabled boolean - Enable roll-back for the repository. Defaults to
false
if not specified. - use
Mercurial 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'.
- manual
Integration Boolean - Limits to manual integration. Defaults to
false
if not specified. - repo
Url String - The URL of the source code repository.
- rollback
Enabled Boolean - Enable roll-back for the repository. Defaults to
false
if not specified. - use
Mercurial Boolean - Use Mercurial if
true
, otherwise uses Git.
AppServiceStorageAccount, AppServiceStorageAccountArgs
- Access
Key string - The access key for the storage account.
- Account
Name string - The name of the storage account.
- Name string
- The name of the storage account identifier.
- string
- The name of the file share (container name, for Blob storage).
- Type string
- The type of storage. Possible values are
AzureBlob
andAzureFiles
. - Mount
Path string - The path to mount the storage within the site's runtime environment.
- Access
Key string - The access key for the storage account.
- Account
Name string - The name of the storage account.
- Name string
- The name of the storage account identifier.
- string
- The name of the file share (container name, for Blob storage).
- Type string
- The type of storage. Possible values are
AzureBlob
andAzureFiles
. - Mount
Path string - The path to mount the storage within the site's runtime environment.
- access
Key String - The access key for the storage account.
- account
Name String - The name of the storage account.
- name String
- The name of the storage account identifier.
- String
- The name of the file share (container name, for Blob storage).
- type String
- The type of storage. Possible values are
AzureBlob
andAzureFiles
. - mount
Path String - The path to mount the storage within the site's runtime environment.
- access
Key string - The access key for the storage account.
- account
Name string - The name of the storage account.
- name string
- The name of the storage account identifier.
- string
- The name of the file share (container name, for Blob storage).
- type string
- The type of storage. Possible values are
AzureBlob
andAzureFiles
. - mount
Path 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.
- str
- The name of the file share (container name, for Blob storage).
- type str
- The type of storage. Possible values are
AzureBlob
andAzureFiles
. - mount_
path str - The path to mount the storage within the site's runtime environment.
- access
Key String - The access key for the storage account.
- account
Name String - The name of the storage account.
- name String
- The name of the storage account identifier.
- String
- The name of the file share (container name, for Blob storage).
- type String
- The type of storage. Possible values are
AzureBlob
andAzureFiles
. - mount
Path String - The path to mount the storage within the site's runtime environment.
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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.