pulumi-azure-native-kotlin/com.pulumi.azurenative.web.kotlin/WebApp

WebApp

class WebApp : KotlinCustomResource

A web app, a mobile app backend, or an API app. Azure REST API version: 2022-09-01. Prior API version in Azure Native 1.x: 2020-12-01. Other available API versions: 2016-08-01, 2018-11-01, 2020-10-01.

Example Usage

Clone web app

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var webApp = new AzureNative.Web.WebApp("webApp", new()
    {
        CloningInfo = new AzureNative.Web.Inputs.CloningInfoArgs
        {
            AppSettingsOverrides =
            {
                { "Setting1", "NewValue1" },
                { "Setting3", "NewValue5" },
            },
            CloneCustomHostNames = true,
            CloneSourceControl = true,
            ConfigureLoadBalancing = false,
            HostingEnvironment = "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg456/providers/Microsoft.Web/hostingenvironments/aseforsites",
            Overwrite = false,
            SourceWebAppId = "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg456/providers/Microsoft.Web/sites/srcsiteg478",
            SourceWebAppLocation = "West Europe",
        },
        Kind = "app",
        Location = "East US",
        Name = "sitef6141",
        ResourceGroupName = "testrg123",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure-native-sdk/web/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := web.NewWebApp(ctx, "webApp", &web.WebAppArgs{
			CloningInfo: &web.CloningInfoArgs{
				AppSettingsOverrides: pulumi.StringMap{
					"Setting1": pulumi.String("NewValue1"),
					"Setting3": pulumi.String("NewValue5"),
				},
				CloneCustomHostNames:   pulumi.Bool(true),
				CloneSourceControl:     pulumi.Bool(true),
				ConfigureLoadBalancing: pulumi.Bool(false),
				HostingEnvironment:     pulumi.String("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg456/providers/Microsoft.Web/hostingenvironments/aseforsites"),
				Overwrite:              pulumi.Bool(false),
				SourceWebAppId:         pulumi.String("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg456/providers/Microsoft.Web/sites/srcsiteg478"),
				SourceWebAppLocation:   pulumi.String("West Europe"),
			},
			Kind:              pulumi.String("app"),
			Location:          pulumi.String("East US"),
			Name:              pulumi.String("sitef6141"),
			ResourceGroupName: pulumi.String("testrg123"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.web.WebApp;
import com.pulumi.azurenative.web.WebAppArgs;
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 webApp = new WebApp("webApp", WebAppArgs.builder()
            .cloningInfo(Map.ofEntries(
                Map.entry("appSettingsOverrides", Map.ofEntries(
                    Map.entry("Setting1", "NewValue1"),
                    Map.entry("Setting3", "NewValue5")
                )),
                Map.entry("cloneCustomHostNames", true),
                Map.entry("cloneSourceControl", true),
                Map.entry("configureLoadBalancing", false),
                Map.entry("hostingEnvironment", "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg456/providers/Microsoft.Web/hostingenvironments/aseforsites"),
                Map.entry("overwrite", false),
                Map.entry("sourceWebAppId", "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg456/providers/Microsoft.Web/sites/srcsiteg478"),
                Map.entry("sourceWebAppLocation", "West Europe")
            ))
            .kind("app")
            .location("East US")
            .name("sitef6141")
            .resourceGroupName("testrg123")
            .build());
    }
}
Content copied to clipboard

Create or Update web app

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var webApp = new AzureNative.Web.WebApp("webApp", new()
    {
        Kind = "app",
        Location = "East US",
        Name = "sitef6141",
        ResourceGroupName = "testrg123",
        ServerFarmId = "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure-native-sdk/web/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := web.NewWebApp(ctx, "webApp", &web.WebAppArgs{
			Kind:              pulumi.String("app"),
			Location:          pulumi.String("East US"),
			Name:              pulumi.String("sitef6141"),
			ResourceGroupName: pulumi.String("testrg123"),
			ServerFarmId:      pulumi.String("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.web.WebApp;
import com.pulumi.azurenative.web.WebAppArgs;
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 webApp = new WebApp("webApp", WebAppArgs.builder()
            .kind("app")
            .location("East US")
            .name("sitef6141")
            .resourceGroupName("testrg123")
            .serverFarmId("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp")
            .build());
    }
}
Content copied to clipboard

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:web:WebApp sitef6141 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
Content copied to clipboard

Properties

Link copied to clipboard
val availabilityState: Output<String>

Management information availability state for the app.

Link copied to clipboard
val clientAffinityEnabled: Output<Boolean>?

true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.

Link copied to clipboard
val clientCertEnabled: Output<Boolean>?

true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.

Link copied to clipboard
val clientCertExclusionPaths: Output<String>?

client certificate authentication comma-separated exclusion paths

Link copied to clipboard
val clientCertMode: Output<String>?

This composes with ClientCertEnabled setting.

Link copied to clipboard
val containerSize: Output<Int>?

Size of the function container.

Link copied to clipboard
val customDomainVerificationId: Output<String>?

Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.

Link copied to clipboard
val dailyMemoryTimeQuota: Output<Int>?

Maximum allowed daily memory-time quota (applicable on dynamic apps only).

Link copied to clipboard
val defaultHostName: Output<String>

Default hostname of the app. Read-only.

Link copied to clipboard
val enabled: Output<Boolean>?

true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).

Link copied to clipboard
val enabledHostNames: Output<List<String>>

Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames.

Link copied to clipboard
val extendedLocation: Output<ExtendedLocationResponse>?

Extended Location.

Link copied to clipboard
val hostingEnvironmentProfile: Output<HostingEnvironmentProfileResponse>?

App Service Environment to use for the app.

Link copied to clipboard
val hostNames: Output<List<String>>

Hostnames associated with the app.

Link copied to clipboard
val hostNamesDisabled: Output<Boolean>?

true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.

Link copied to clipboard
val hostNameSslStates: Output<List<HostNameSslStateResponse>>?

Hostname SSL states are used to manage the SSL bindings for app's hostnames.

Link copied to clipboard
val httpsOnly: Output<Boolean>?

HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests

Link copied to clipboard
val hyperV: Output<Boolean>?

Hyper-V sandbox.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val identity: Output<ManagedServiceIdentityResponse>?

Managed service identity.

Link copied to clipboard
val inProgressOperationId: Output<String>

Specifies an operation id if this site has a pending operation.

Link copied to clipboard
val isDefaultContainer: Output<Boolean>

true if the app is a default container; otherwise, false.

Link copied to clipboard
val isXenon: Output<Boolean>?

Obsolete: Hyper-V sandbox.

Link copied to clipboard
val keyVaultReferenceIdentity: Output<String>?

Identity to use for Key Vault Reference authentication.

Link copied to clipboard
val kind: Output<String>?

Kind of resource.

Link copied to clipboard
val lastModifiedTimeUtc: Output<String>

Last time the app was modified, in UTC. Read-only.

Link copied to clipboard
val location: Output<String>

Resource Location.

Link copied to clipboard
val managedEnvironmentId: Output<String>?

Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}

Link copied to clipboard
val maxNumberOfWorkers: Output<Int>

Maximum number of workers. This only applies to Functions container.

Link copied to clipboard
val name: Output<String>

Resource Name.

Link copied to clipboard
val outboundIpAddresses: Output<String>

List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.

Link copied to clipboard
val possibleOutboundIpAddresses: Output<String>

List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.

Link copied to clipboard
val publicNetworkAccess: Output<String>?

Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val redundancyMode: Output<String>?

Site redundancy mode

Link copied to clipboard
val repositorySiteName: Output<String>

Name of the repository site.

Link copied to clipboard
val reserved: Output<Boolean>?

true if reserved; otherwise, false.

Link copied to clipboard
val resourceGroup: Output<String>

Name of the resource group the app belongs to. Read-only.

Link copied to clipboard
val scmSiteAlsoStopped: Output<Boolean>?

true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.

Link copied to clipboard
val serverFarmId: Output<String>?

Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

Link copied to clipboard
val siteConfig: Output<SiteConfigResponse>?

Configuration of the app.

Link copied to clipboard
val slotSwapStatus: Output<SlotSwapStatusResponse>

Status of the last deployment slot swap operation.

Link copied to clipboard
val state: Output<String>

Current state of the app.

Link copied to clipboard
val storageAccountRequired: Output<Boolean>?

Checks if Customer provided storage account is required

Link copied to clipboard
val suspendedTill: Output<String>

App suspended till in case memory-time quota is exceeded.

Link copied to clipboard
val tags: Output<Map<String, String>>?

Resource tags.

Link copied to clipboard
val targetSwapSlot: Output<String>

Specifies which deployment slot this app will swap into. Read-only.

Link copied to clipboard
val trafficManagerHostNames: Output<List<String>>

Azure Traffic Manager hostnames associated with the app. Read-only.

Link copied to clipboard
val type: Output<String>

Resource type.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val usageState: Output<String>

State indicating whether the app has exceeded its quota usage. Read-only.

Link copied to clipboard
val virtualNetworkSubnetId: Output<String>?

Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}

Link copied to clipboard
val vnetContentShareEnabled: Output<Boolean>?

To enable accessing content over virtual network

Link copied to clipboard
val vnetImagePullEnabled: Output<Boolean>?

To enable pulling image over Virtual Network

Link copied to clipboard
val vnetRouteAllEnabled: Output<Boolean>?

Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.