Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. AppServiceEnvironment
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.web.AppServiceEnvironment

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

    App Service Environment ARM resource. Azure REST API version: 2022-09-01. Prior API version in Azure Native 1.x: 2020-12-01.

    Other available API versions: 2019-08-01, 2020-10-01, 2021-01-15, 2023-01-01, 2023-12-01, 2024-04-01.

    Example Usage

    Create or update an App Service Environment.

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var appServiceEnvironment = new AzureNative.Web.AppServiceEnvironment("appServiceEnvironment", new()
    {
        Kind = "Asev3",
        Location = "South Central US",
        Name = "test-ase",
        ResourceGroupName = "test-rg",
        VirtualNetwork = new AzureNative.Web.Inputs.VirtualNetworkProfileArgs
        {
            Id = "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/delegated",
        },
    });

});

    package main

import (
	web "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.NewAppServiceEnvironment(ctx, "appServiceEnvironment", &web.AppServiceEnvironmentArgs{
			Kind:              pulumi.String("Asev3"),
			Location:          pulumi.String("South Central US"),
			Name:              pulumi.String("test-ase"),
			ResourceGroupName: pulumi.String("test-rg"),
			VirtualNetwork: &web.VirtualNetworkProfileArgs{
				Id: pulumi.String("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/delegated"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.web.AppServiceEnvironment;
import com.pulumi.azurenative.web.AppServiceEnvironmentArgs;
import com.pulumi.azurenative.web.inputs.VirtualNetworkProfileArgs;
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 appServiceEnvironment = new AppServiceEnvironment("appServiceEnvironment", AppServiceEnvironmentArgs.builder()
            .kind("Asev3")
            .location("South Central US")
            .name("test-ase")
            .resourceGroupName("test-rg")
            .virtualNetwork(VirtualNetworkProfileArgs.builder()
                .id("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/delegated")
                .build())
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

app_service_environment = azure_native.web.AppServiceEnvironment("appServiceEnvironment",
    kind="Asev3",
    location="South Central US",
    name="test-ase",
    resource_group_name="test-rg",
    virtual_network={
        "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/delegated",
    })

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const appServiceEnvironment = new azure_native.web.AppServiceEnvironment("appServiceEnvironment", {
    kind: "Asev3",
    location: "South Central US",
    name: "test-ase",
    resourceGroupName: "test-rg",
    virtualNetwork: {
        id: "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/delegated",
    },
});

    resources:
  appServiceEnvironment:
    type: azure-native:web:AppServiceEnvironment
    properties:
      kind: Asev3
      location: South Central US
      name: test-ase
      resourceGroupName: test-rg
      virtualNetwork:
        id: /subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/delegated

    Create AppServiceEnvironment Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AppServiceEnvironment(name: string, args: AppServiceEnvironmentArgs, opts?: CustomResourceOptions);
    @overload
def AppServiceEnvironment(resource_name: str,
                          args: AppServiceEnvironmentArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def AppServiceEnvironment(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          resource_group_name: Optional[str] = None,
                          virtual_network: Optional[VirtualNetworkProfileArgs] = None,
                          front_end_scale_factor: Optional[int] = None,
                          multi_size: Optional[str] = None,
                          cluster_settings: Optional[Sequence[NameValuePairArgs]] = None,
                          internal_load_balancing_mode: Optional[Union[str, LoadBalancingMode]] = None,
                          ipssl_address_count: Optional[int] = None,
                          kind: Optional[str] = None,
                          location: Optional[str] = None,
                          dns_suffix: Optional[str] = None,
                          name: Optional[str] = None,
                          networking_configuration: Optional[AseV3NetworkingConfigurationArgs] = None,
                          dedicated_host_count: Optional[int] = None,
                          tags: Optional[Mapping[str, str]] = None,
                          upgrade_preference: Optional[Union[str, UpgradePreference]] = None,
                          user_whitelisted_ip_ranges: Optional[Sequence[str]] = None,
                          custom_dns_suffix_configuration: Optional[CustomDnsSuffixConfigurationArgs] = None,
                          zone_redundant: Optional[bool] = None)
    func NewAppServiceEnvironment(ctx *Context, name string, args AppServiceEnvironmentArgs, opts ...ResourceOption) (*AppServiceEnvironment, error)
    public AppServiceEnvironment(string name, AppServiceEnvironmentArgs args, CustomResourceOptions? opts = null)
    public AppServiceEnvironment(String name, AppServiceEnvironmentArgs args)
public AppServiceEnvironment(String name, AppServiceEnvironmentArgs args, CustomResourceOptions options)

    type: azure-native:web:AppServiceEnvironment
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 AppServiceEnvironmentArgs
    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 AppServiceEnvironmentArgs
    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 AppServiceEnvironmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppServiceEnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppServiceEnvironmentArgs
    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 appServiceEnvironmentResource = new AzureNative.Web.AppServiceEnvironment("appServiceEnvironmentResource", new()
{
    ResourceGroupName = "string",
    VirtualNetwork = new AzureNative.Web.Inputs.VirtualNetworkProfileArgs
    {
        Id = "string",
        Subnet = "string",
    },
    FrontEndScaleFactor = 0,
    MultiSize = "string",
    ClusterSettings = new[]
    {
        new AzureNative.Web.Inputs.NameValuePairArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    InternalLoadBalancingMode = "string",
    IpsslAddressCount = 0,
    Kind = "string",
    Location = "string",
    DnsSuffix = "string",
    Name = "string",
    NetworkingConfiguration = new AzureNative.Web.Inputs.AseV3NetworkingConfigurationArgs
    {
        AllowNewPrivateEndpointConnections = false,
        FtpEnabled = false,
        InboundIpAddressOverride = "string",
        Kind = "string",
        RemoteDebugEnabled = false,
    },
    DedicatedHostCount = 0,
    Tags = 
    {
        { "string", "string" },
    },
    UpgradePreference = "string",
    UserWhitelistedIpRanges = new[]
    {
        "string",
    },
    CustomDnsSuffixConfiguration = new AzureNative.Web.Inputs.CustomDnsSuffixConfigurationArgs
    {
        CertificateUrl = "string",
        DnsSuffix = "string",
        KeyVaultReferenceIdentity = "string",
        Kind = "string",
    },
    ZoneRedundant = false,
});

    example, err := web.NewAppServiceEnvironment(ctx, "appServiceEnvironmentResource", &web.AppServiceEnvironmentArgs{
	ResourceGroupName: pulumi.String("string"),
	VirtualNetwork: &web.VirtualNetworkProfileArgs{
		Id:     pulumi.String("string"),
		Subnet: pulumi.String("string"),
	},
	FrontEndScaleFactor: pulumi.Int(0),
	MultiSize:           pulumi.String("string"),
	ClusterSettings: web.NameValuePairArray{
		&web.NameValuePairArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	InternalLoadBalancingMode: pulumi.String("string"),
	IpsslAddressCount:         pulumi.Int(0),
	Kind:                      pulumi.String("string"),
	Location:                  pulumi.String("string"),
	DnsSuffix:                 pulumi.String("string"),
	Name:                      pulumi.String("string"),
	NetworkingConfiguration: &web.AseV3NetworkingConfigurationArgs{
		AllowNewPrivateEndpointConnections: pulumi.Bool(false),
		FtpEnabled:                         pulumi.Bool(false),
		InboundIpAddressOverride:           pulumi.String("string"),
		Kind:                               pulumi.String("string"),
		RemoteDebugEnabled:                 pulumi.Bool(false),
	},
	DedicatedHostCount: pulumi.Int(0),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	UpgradePreference: pulumi.String("string"),
	UserWhitelistedIpRanges: pulumi.StringArray{
		pulumi.String("string"),
	},
	CustomDnsSuffixConfiguration: &web.CustomDnsSuffixConfigurationArgs{
		CertificateUrl:            pulumi.String("string"),
		DnsSuffix:                 pulumi.String("string"),
		KeyVaultReferenceIdentity: pulumi.String("string"),
		Kind:                      pulumi.String("string"),
	},
	ZoneRedundant: pulumi.Bool(false),
})

    var appServiceEnvironmentResource = new AppServiceEnvironment("appServiceEnvironmentResource", AppServiceEnvironmentArgs.builder()
    .resourceGroupName("string")
    .virtualNetwork(VirtualNetworkProfileArgs.builder()
        .id("string")
        .subnet("string")
        .build())
    .frontEndScaleFactor(0)
    .multiSize("string")
    .clusterSettings(NameValuePairArgs.builder()
        .name("string")
        .value("string")
        .build())
    .internalLoadBalancingMode("string")
    .ipsslAddressCount(0)
    .kind("string")
    .location("string")
    .dnsSuffix("string")
    .name("string")
    .networkingConfiguration(AseV3NetworkingConfigurationArgs.builder()
        .allowNewPrivateEndpointConnections(false)
        .ftpEnabled(false)
        .inboundIpAddressOverride("string")
        .kind("string")
        .remoteDebugEnabled(false)
        .build())
    .dedicatedHostCount(0)
    .tags(Map.of("string", "string"))
    .upgradePreference("string")
    .userWhitelistedIpRanges("string")
    .customDnsSuffixConfiguration(CustomDnsSuffixConfigurationArgs.builder()
        .certificateUrl("string")
        .dnsSuffix("string")
        .keyVaultReferenceIdentity("string")
        .kind("string")
        .build())
    .zoneRedundant(false)
    .build());

    app_service_environment_resource = azure_native.web.AppServiceEnvironment("appServiceEnvironmentResource",
    resource_group_name="string",
    virtual_network={
        "id": "string",
        "subnet": "string",
    },
    front_end_scale_factor=0,
    multi_size="string",
    cluster_settings=[{
        "name": "string",
        "value": "string",
    }],
    internal_load_balancing_mode="string",
    ipssl_address_count=0,
    kind="string",
    location="string",
    dns_suffix="string",
    name="string",
    networking_configuration={
        "allow_new_private_endpoint_connections": False,
        "ftp_enabled": False,
        "inbound_ip_address_override": "string",
        "kind": "string",
        "remote_debug_enabled": False,
    },
    dedicated_host_count=0,
    tags={
        "string": "string",
    },
    upgrade_preference="string",
    user_whitelisted_ip_ranges=["string"],
    custom_dns_suffix_configuration={
        "certificate_url": "string",
        "dns_suffix": "string",
        "key_vault_reference_identity": "string",
        "kind": "string",
    },
    zone_redundant=False)

    const appServiceEnvironmentResource = new azure_native.web.AppServiceEnvironment("appServiceEnvironmentResource", {
    resourceGroupName: "string",
    virtualNetwork: {
        id: "string",
        subnet: "string",
    },
    frontEndScaleFactor: 0,
    multiSize: "string",
    clusterSettings: [{
        name: "string",
        value: "string",
    }],
    internalLoadBalancingMode: "string",
    ipsslAddressCount: 0,
    kind: "string",
    location: "string",
    dnsSuffix: "string",
    name: "string",
    networkingConfiguration: {
        allowNewPrivateEndpointConnections: false,
        ftpEnabled: false,
        inboundIpAddressOverride: "string",
        kind: "string",
        remoteDebugEnabled: false,
    },
    dedicatedHostCount: 0,
    tags: {
        string: "string",
    },
    upgradePreference: "string",
    userWhitelistedIpRanges: ["string"],
    customDnsSuffixConfiguration: {
        certificateUrl: "string",
        dnsSuffix: "string",
        keyVaultReferenceIdentity: "string",
        kind: "string",
    },
    zoneRedundant: false,
});

    type: azure-native:web:AppServiceEnvironment
properties:
    clusterSettings:
        - name: string
          value: string
    customDnsSuffixConfiguration:
        certificateUrl: string
        dnsSuffix: string
        keyVaultReferenceIdentity: string
        kind: string
    dedicatedHostCount: 0
    dnsSuffix: string
    frontEndScaleFactor: 0
    internalLoadBalancingMode: string
    ipsslAddressCount: 0
    kind: string
    location: string
    multiSize: string
    name: string
    networkingConfiguration:
        allowNewPrivateEndpointConnections: false
        ftpEnabled: false
        inboundIpAddressOverride: string
        kind: string
        remoteDebugEnabled: false
    resourceGroupName: string
    tags:
        string: string
    upgradePreference: string
    userWhitelistedIpRanges:
        - string
    virtualNetwork:
        id: string
        subnet: string
    zoneRedundant: false

    AppServiceEnvironment Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AppServiceEnvironment resource accepts the following input properties:

    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    VirtualNetwork Pulumi.AzureNative.Web.Inputs.VirtualNetworkProfile
    Description of the Virtual Network.
    ClusterSettings List<Pulumi.AzureNative.Web.Inputs.NameValuePair>
    Custom settings for changing the behavior of the App Service Environment.
    CustomDnsSuffixConfiguration Pulumi.AzureNative.Web.Inputs.CustomDnsSuffixConfiguration
    Full view of the custom domain suffix configuration for ASEv3.
    DedicatedHostCount int
    Dedicated Host Count
    DnsSuffix string
    DNS suffix of the App Service Environment.
    FrontEndScaleFactor int
    Scale factor for front-ends.
    InternalLoadBalancingMode string | Pulumi.AzureNative.Web.LoadBalancingMode
    Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
    IpsslAddressCount int
    Number of IP SSL addresses reserved for the App Service Environment.
    Kind string
    Kind of resource.
    Location string
    Resource Location.
    MultiSize string
    Front-end VM size, e.g. "Medium", "Large".
    Name string
    Name of the App Service Environment.
    NetworkingConfiguration Pulumi.AzureNative.Web.Inputs.AseV3NetworkingConfiguration
    Full view of networking configuration for an ASE.
    Tags Dictionary<string, string>
    Resource tags.
    UpgradePreference string | Pulumi.AzureNative.Web.UpgradePreference
    Upgrade Preference
    UserWhitelistedIpRanges List<string>
    User added ip ranges to whitelist on ASE db
    ZoneRedundant bool
    Whether or not this App Service Environment is zone-redundant.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    VirtualNetwork VirtualNetworkProfileArgs
    Description of the Virtual Network.
    ClusterSettings []NameValuePairArgs
    Custom settings for changing the behavior of the App Service Environment.
    CustomDnsSuffixConfiguration CustomDnsSuffixConfigurationArgs
    Full view of the custom domain suffix configuration for ASEv3.
    DedicatedHostCount int
    Dedicated Host Count
    DnsSuffix string
    DNS suffix of the App Service Environment.
    FrontEndScaleFactor int
    Scale factor for front-ends.
    InternalLoadBalancingMode string | LoadBalancingMode
    Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
    IpsslAddressCount int
    Number of IP SSL addresses reserved for the App Service Environment.
    Kind string
    Kind of resource.
    Location string
    Resource Location.
    MultiSize string
    Front-end VM size, e.g. "Medium", "Large".
    Name string
    Name of the App Service Environment.
    NetworkingConfiguration AseV3NetworkingConfigurationArgs
    Full view of networking configuration for an ASE.
    Tags map[string]string
    Resource tags.
    UpgradePreference string | UpgradePreference
    Upgrade Preference
    UserWhitelistedIpRanges []string
    User added ip ranges to whitelist on ASE db
    ZoneRedundant bool
    Whether or not this App Service Environment is zone-redundant.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    virtualNetwork VirtualNetworkProfile
    Description of the Virtual Network.
    clusterSettings List<NameValuePair>
    Custom settings for changing the behavior of the App Service Environment.
    customDnsSuffixConfiguration CustomDnsSuffixConfiguration
    Full view of the custom domain suffix configuration for ASEv3.
    dedicatedHostCount Integer
    Dedicated Host Count
    dnsSuffix String
    DNS suffix of the App Service Environment.
    frontEndScaleFactor Integer
    Scale factor for front-ends.
    internalLoadBalancingMode String | LoadBalancingMode
    Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
    ipsslAddressCount Integer
    Number of IP SSL addresses reserved for the App Service Environment.
    kind String
    Kind of resource.
    location String
    Resource Location.
    multiSize String
    Front-end VM size, e.g. "Medium", "Large".
    name String
    Name of the App Service Environment.
    networkingConfiguration AseV3NetworkingConfiguration
    Full view of networking configuration for an ASE.
    tags Map<String,String>
    Resource tags.
    upgradePreference String | UpgradePreference
    Upgrade Preference
    userWhitelistedIpRanges List<String>
    User added ip ranges to whitelist on ASE db
    zoneRedundant Boolean
    Whether or not this App Service Environment is zone-redundant.
    resourceGroupName string
    Name of the resource group to which the resource belongs.
    virtualNetwork VirtualNetworkProfile
    Description of the Virtual Network.
    clusterSettings NameValuePair[]
    Custom settings for changing the behavior of the App Service Environment.
    customDnsSuffixConfiguration CustomDnsSuffixConfiguration
    Full view of the custom domain suffix configuration for ASEv3.
    dedicatedHostCount number
    Dedicated Host Count
    dnsSuffix string
    DNS suffix of the App Service Environment.
    frontEndScaleFactor number
    Scale factor for front-ends.
    internalLoadBalancingMode string | LoadBalancingMode
    Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
    ipsslAddressCount number
    Number of IP SSL addresses reserved for the App Service Environment.
    kind string
    Kind of resource.
    location string
    Resource Location.
    multiSize string
    Front-end VM size, e.g. "Medium", "Large".
    name string
    Name of the App Service Environment.
    networkingConfiguration AseV3NetworkingConfiguration
    Full view of networking configuration for an ASE.
    tags {[key: string]: string}
    Resource tags.
    upgradePreference string | UpgradePreference
    Upgrade Preference
    userWhitelistedIpRanges string[]
    User added ip ranges to whitelist on ASE db
    zoneRedundant boolean
    Whether or not this App Service Environment is zone-redundant.
    resource_group_name str
    Name of the resource group to which the resource belongs.
    virtual_network VirtualNetworkProfileArgs
    Description of the Virtual Network.
    cluster_settings Sequence[NameValuePairArgs]
    Custom settings for changing the behavior of the App Service Environment.
    custom_dns_suffix_configuration CustomDnsSuffixConfigurationArgs
    Full view of the custom domain suffix configuration for ASEv3.
    dedicated_host_count int
    Dedicated Host Count
    dns_suffix str
    DNS suffix of the App Service Environment.
    front_end_scale_factor int
    Scale factor for front-ends.
    internal_load_balancing_mode str | LoadBalancingMode
    Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
    ipssl_address_count int
    Number of IP SSL addresses reserved for the App Service Environment.
    kind str
    Kind of resource.
    location str
    Resource Location.
    multi_size str
    Front-end VM size, e.g. "Medium", "Large".
    name str
    Name of the App Service Environment.
    networking_configuration AseV3NetworkingConfigurationArgs
    Full view of networking configuration for an ASE.
    tags Mapping[str, str]
    Resource tags.
    upgrade_preference str | UpgradePreference
    Upgrade Preference
    user_whitelisted_ip_ranges Sequence[str]
    User added ip ranges to whitelist on ASE db
    zone_redundant bool
    Whether or not this App Service Environment is zone-redundant.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    virtualNetwork Property Map
    Description of the Virtual Network.
    clusterSettings List<Property Map>
    Custom settings for changing the behavior of the App Service Environment.
    customDnsSuffixConfiguration Property Map
    Full view of the custom domain suffix configuration for ASEv3.
    dedicatedHostCount Number
    Dedicated Host Count
    dnsSuffix String
    DNS suffix of the App Service Environment.
    frontEndScaleFactor Number
    Scale factor for front-ends.
    internalLoadBalancingMode String | "None" | "Web" | "Publishing" | "Web, Publishing"
    Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
    ipsslAddressCount Number
    Number of IP SSL addresses reserved for the App Service Environment.
    kind String
    Kind of resource.
    location String
    Resource Location.
    multiSize String
    Front-end VM size, e.g. "Medium", "Large".
    name String
    Name of the App Service Environment.
    networkingConfiguration Property Map
    Full view of networking configuration for an ASE.
    tags Map<String>
    Resource tags.
    upgradePreference String | "None" | "Early" | "Late" | "Manual"
    Upgrade Preference
    userWhitelistedIpRanges List<String>
    User added ip ranges to whitelist on ASE db
    zoneRedundant Boolean
    Whether or not this App Service Environment is zone-redundant.

    Outputs

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

    HasLinuxWorkers bool
    Flag that displays whether an ASE has linux workers or not
    Id string
    The provider-assigned unique ID for this managed resource.
    MaximumNumberOfMachines int
    Maximum number of VMs in the App Service Environment.
    MultiRoleCount int
    Number of front-end instances.
    ProvisioningState string
    Provisioning state of the App Service Environment.
    Status string
    Current status of the App Service Environment.
    Suspended bool
    true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
    Type string
    Resource type.
    UpgradeAvailability string
    Whether an upgrade is available for this App Service Environment.
    HasLinuxWorkers bool
    Flag that displays whether an ASE has linux workers or not
    Id string
    The provider-assigned unique ID for this managed resource.
    MaximumNumberOfMachines int
    Maximum number of VMs in the App Service Environment.
    MultiRoleCount int
    Number of front-end instances.
    ProvisioningState string
    Provisioning state of the App Service Environment.
    Status string
    Current status of the App Service Environment.
    Suspended bool
    true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
    Type string
    Resource type.
    UpgradeAvailability string
    Whether an upgrade is available for this App Service Environment.
    hasLinuxWorkers Boolean
    Flag that displays whether an ASE has linux workers or not
    id String
    The provider-assigned unique ID for this managed resource.
    maximumNumberOfMachines Integer
    Maximum number of VMs in the App Service Environment.
    multiRoleCount Integer
    Number of front-end instances.
    provisioningState String
    Provisioning state of the App Service Environment.
    status String
    Current status of the App Service Environment.
    suspended Boolean
    true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
    type String
    Resource type.
    upgradeAvailability String
    Whether an upgrade is available for this App Service Environment.
    hasLinuxWorkers boolean
    Flag that displays whether an ASE has linux workers or not
    id string
    The provider-assigned unique ID for this managed resource.
    maximumNumberOfMachines number
    Maximum number of VMs in the App Service Environment.
    multiRoleCount number
    Number of front-end instances.
    provisioningState string
    Provisioning state of the App Service Environment.
    status string
    Current status of the App Service Environment.
    suspended boolean
    true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
    type string
    Resource type.
    upgradeAvailability string
    Whether an upgrade is available for this App Service Environment.
    has_linux_workers bool
    Flag that displays whether an ASE has linux workers or not
    id str
    The provider-assigned unique ID for this managed resource.
    maximum_number_of_machines int
    Maximum number of VMs in the App Service Environment.
    multi_role_count int
    Number of front-end instances.
    provisioning_state str
    Provisioning state of the App Service Environment.
    status str
    Current status of the App Service Environment.
    suspended bool
    true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
    type str
    Resource type.
    upgrade_availability str
    Whether an upgrade is available for this App Service Environment.
    hasLinuxWorkers Boolean
    Flag that displays whether an ASE has linux workers or not
    id String
    The provider-assigned unique ID for this managed resource.
    maximumNumberOfMachines Number
    Maximum number of VMs in the App Service Environment.
    multiRoleCount Number
    Number of front-end instances.
    provisioningState String
    Provisioning state of the App Service Environment.
    status String
    Current status of the App Service Environment.
    suspended Boolean
    true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
    type String
    Resource type.
    upgradeAvailability String
    Whether an upgrade is available for this App Service Environment.

    Supporting Types

    AseV3NetworkingConfiguration, AseV3NetworkingConfigurationArgs

    AllowNewPrivateEndpointConnections bool
    Property to enable and disable new private endpoint connection creation on ASE
    FtpEnabled bool
    Property to enable and disable FTP on ASEV3
    InboundIpAddressOverride string
    Customer provided Inbound IP Address. Only able to be set on Ase create.
    Kind string
    Kind of resource.
    RemoteDebugEnabled bool
    Property to enable and disable Remote Debug on ASEV3
    AllowNewPrivateEndpointConnections bool
    Property to enable and disable new private endpoint connection creation on ASE
    FtpEnabled bool
    Property to enable and disable FTP on ASEV3
    InboundIpAddressOverride string
    Customer provided Inbound IP Address. Only able to be set on Ase create.
    Kind string
    Kind of resource.
    RemoteDebugEnabled bool
    Property to enable and disable Remote Debug on ASEV3
    allowNewPrivateEndpointConnections Boolean
    Property to enable and disable new private endpoint connection creation on ASE
    ftpEnabled Boolean
    Property to enable and disable FTP on ASEV3
    inboundIpAddressOverride String
    Customer provided Inbound IP Address. Only able to be set on Ase create.
    kind String
    Kind of resource.
    remoteDebugEnabled Boolean
    Property to enable and disable Remote Debug on ASEV3
    allowNewPrivateEndpointConnections boolean
    Property to enable and disable new private endpoint connection creation on ASE
    ftpEnabled boolean
    Property to enable and disable FTP on ASEV3
    inboundIpAddressOverride string
    Customer provided Inbound IP Address. Only able to be set on Ase create.
    kind string
    Kind of resource.
    remoteDebugEnabled boolean
    Property to enable and disable Remote Debug on ASEV3
    allow_new_private_endpoint_connections bool
    Property to enable and disable new private endpoint connection creation on ASE
    ftp_enabled bool
    Property to enable and disable FTP on ASEV3
    inbound_ip_address_override str
    Customer provided Inbound IP Address. Only able to be set on Ase create.
    kind str
    Kind of resource.
    remote_debug_enabled bool
    Property to enable and disable Remote Debug on ASEV3
    allowNewPrivateEndpointConnections Boolean
    Property to enable and disable new private endpoint connection creation on ASE
    ftpEnabled Boolean
    Property to enable and disable FTP on ASEV3
    inboundIpAddressOverride String
    Customer provided Inbound IP Address. Only able to be set on Ase create.
    kind String
    Kind of resource.
    remoteDebugEnabled Boolean
    Property to enable and disable Remote Debug on ASEV3

    AseV3NetworkingConfigurationResponse, AseV3NetworkingConfigurationResponseArgs

    ExternalInboundIpAddresses List<string>
    Id string
    Resource Id.
    InternalInboundIpAddresses List<string>
    LinuxOutboundIpAddresses List<string>
    Name string
    Resource Name.
    Type string
    Resource type.
    WindowsOutboundIpAddresses List<string>
    AllowNewPrivateEndpointConnections bool
    Property to enable and disable new private endpoint connection creation on ASE
    FtpEnabled bool
    Property to enable and disable FTP on ASEV3
    InboundIpAddressOverride string
    Customer provided Inbound IP Address. Only able to be set on Ase create.
    Kind string
    Kind of resource.
    RemoteDebugEnabled bool
    Property to enable and disable Remote Debug on ASEV3
    ExternalInboundIpAddresses []string
    Id string
    Resource Id.
    InternalInboundIpAddresses []string
    LinuxOutboundIpAddresses []string
    Name string
    Resource Name.
    Type string
    Resource type.
    WindowsOutboundIpAddresses []string
    AllowNewPrivateEndpointConnections bool
    Property to enable and disable new private endpoint connection creation on ASE
    FtpEnabled bool
    Property to enable and disable FTP on ASEV3
    InboundIpAddressOverride string
    Customer provided Inbound IP Address. Only able to be set on Ase create.
    Kind string
    Kind of resource.
    RemoteDebugEnabled bool
    Property to enable and disable Remote Debug on ASEV3
    externalInboundIpAddresses List<String>
    id String
    Resource Id.
    internalInboundIpAddresses List<String>
    linuxOutboundIpAddresses List<String>
    name String
    Resource Name.
    type String
    Resource type.
    windowsOutboundIpAddresses List<String>
    allowNewPrivateEndpointConnections Boolean
    Property to enable and disable new private endpoint connection creation on ASE
    ftpEnabled Boolean
    Property to enable and disable FTP on ASEV3
    inboundIpAddressOverride String
    Customer provided Inbound IP Address. Only able to be set on Ase create.
    kind String
    Kind of resource.
    remoteDebugEnabled Boolean
    Property to enable and disable Remote Debug on ASEV3
    externalInboundIpAddresses string[]
    id string
    Resource Id.
    internalInboundIpAddresses string[]
    linuxOutboundIpAddresses string[]
    name string
    Resource Name.
    type string
    Resource type.
    windowsOutboundIpAddresses string[]
    allowNewPrivateEndpointConnections boolean
    Property to enable and disable new private endpoint connection creation on ASE
    ftpEnabled boolean
    Property to enable and disable FTP on ASEV3
    inboundIpAddressOverride string
    Customer provided Inbound IP Address. Only able to be set on Ase create.
    kind string
    Kind of resource.
    remoteDebugEnabled boolean
    Property to enable and disable Remote Debug on ASEV3
    external_inbound_ip_addresses Sequence[str]
    id str
    Resource Id.
    internal_inbound_ip_addresses Sequence[str]
    linux_outbound_ip_addresses Sequence[str]
    name str
    Resource Name.
    type str
    Resource type.
    windows_outbound_ip_addresses Sequence[str]
    allow_new_private_endpoint_connections bool
    Property to enable and disable new private endpoint connection creation on ASE
    ftp_enabled bool
    Property to enable and disable FTP on ASEV3
    inbound_ip_address_override str
    Customer provided Inbound IP Address. Only able to be set on Ase create.
    kind str
    Kind of resource.
    remote_debug_enabled bool
    Property to enable and disable Remote Debug on ASEV3
    externalInboundIpAddresses List<String>
    id String
    Resource Id.
    internalInboundIpAddresses List<String>
    linuxOutboundIpAddresses List<String>
    name String
    Resource Name.
    type String
    Resource type.
    windowsOutboundIpAddresses List<String>
    allowNewPrivateEndpointConnections Boolean
    Property to enable and disable new private endpoint connection creation on ASE
    ftpEnabled Boolean
    Property to enable and disable FTP on ASEV3
    inboundIpAddressOverride String
    Customer provided Inbound IP Address. Only able to be set on Ase create.
    kind String
    Kind of resource.
    remoteDebugEnabled Boolean
    Property to enable and disable Remote Debug on ASEV3

    CustomDnsSuffixConfiguration, CustomDnsSuffixConfigurationArgs

    CertificateUrl string
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    DnsSuffix string
    The default custom domain suffix to use for all sites deployed on the ASE.
    KeyVaultReferenceIdentity string
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    Kind string
    Kind of resource.
    CertificateUrl string
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    DnsSuffix string
    The default custom domain suffix to use for all sites deployed on the ASE.
    KeyVaultReferenceIdentity string
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    Kind string
    Kind of resource.
    certificateUrl String
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    dnsSuffix String
    The default custom domain suffix to use for all sites deployed on the ASE.
    keyVaultReferenceIdentity String
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    kind String
    Kind of resource.
    certificateUrl string
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    dnsSuffix string
    The default custom domain suffix to use for all sites deployed on the ASE.
    keyVaultReferenceIdentity string
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    kind string
    Kind of resource.
    certificate_url str
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    dns_suffix str
    The default custom domain suffix to use for all sites deployed on the ASE.
    key_vault_reference_identity str
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    kind str
    Kind of resource.
    certificateUrl String
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    dnsSuffix String
    The default custom domain suffix to use for all sites deployed on the ASE.
    keyVaultReferenceIdentity String
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    kind String
    Kind of resource.

    CustomDnsSuffixConfigurationResponse, CustomDnsSuffixConfigurationResponseArgs

    Id string
    Resource Id.
    Name string
    Resource Name.
    ProvisioningDetails string
    ProvisioningState string
    Type string
    Resource type.
    CertificateUrl string
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    DnsSuffix string
    The default custom domain suffix to use for all sites deployed on the ASE.
    KeyVaultReferenceIdentity string
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    Kind string
    Kind of resource.
    Id string
    Resource Id.
    Name string
    Resource Name.
    ProvisioningDetails string
    ProvisioningState string
    Type string
    Resource type.
    CertificateUrl string
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    DnsSuffix string
    The default custom domain suffix to use for all sites deployed on the ASE.
    KeyVaultReferenceIdentity string
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    Kind string
    Kind of resource.
    id String
    Resource Id.
    name String
    Resource Name.
    provisioningDetails String
    provisioningState String
    type String
    Resource type.
    certificateUrl String
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    dnsSuffix String
    The default custom domain suffix to use for all sites deployed on the ASE.
    keyVaultReferenceIdentity String
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    kind String
    Kind of resource.
    id string
    Resource Id.
    name string
    Resource Name.
    provisioningDetails string
    provisioningState string
    type string
    Resource type.
    certificateUrl string
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    dnsSuffix string
    The default custom domain suffix to use for all sites deployed on the ASE.
    keyVaultReferenceIdentity string
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    kind string
    Kind of resource.
    id str
    Resource Id.
    name str
    Resource Name.
    provisioning_details str
    provisioning_state str
    type str
    Resource type.
    certificate_url str
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    dns_suffix str
    The default custom domain suffix to use for all sites deployed on the ASE.
    key_vault_reference_identity str
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    kind str
    Kind of resource.
    id String
    Resource Id.
    name String
    Resource Name.
    provisioningDetails String
    provisioningState String
    type String
    Resource type.
    certificateUrl String
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    dnsSuffix String
    The default custom domain suffix to use for all sites deployed on the ASE.
    keyVaultReferenceIdentity String
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    kind String
    Kind of resource.

    LoadBalancingMode, LoadBalancingModeArgs

    None
    None
    Web
    Web
    Publishing
    Publishing
    Web_Publishing
    Web, Publishing
    LoadBalancingModeNone
    None
    LoadBalancingModeWeb
    Web
    LoadBalancingModePublishing
    Publishing
    LoadBalancingMode_Web_Publishing
    Web, Publishing
    None
    None
    Web
    Web
    Publishing
    Publishing
    Web_Publishing
    Web, Publishing
    None
    None
    Web
    Web
    Publishing
    Publishing
    Web_Publishing
    Web, Publishing
    NONE
    None
    WEB
    Web
    PUBLISHING
    Publishing
    WEB_PUBLISHING
    Web, Publishing
    "None"
    None
    "Web"
    Web
    "Publishing"
    Publishing
    "Web, Publishing"
    Web, Publishing

    NameValuePair, NameValuePairArgs

    Name string
    Pair name.
    Value string
    Pair value.
    Name string
    Pair name.
    Value string
    Pair value.
    name String
    Pair name.
    value String
    Pair value.
    name string
    Pair name.
    value string
    Pair value.
    name str
    Pair name.
    value str
    Pair value.
    name String
    Pair name.
    value String
    Pair value.

    NameValuePairResponse, NameValuePairResponseArgs

    Name string
    Pair name.
    Value string
    Pair value.
    Name string
    Pair name.
    Value string
    Pair value.
    name String
    Pair name.
    value String
    Pair value.
    name string
    Pair name.
    value string
    Pair value.
    name str
    Pair name.
    value str
    Pair value.
    name String
    Pair name.
    value String
    Pair value.

    UpgradePreference, UpgradePreferenceArgs

    None
    NoneNo preference on when this App Service Environment will be upgraded
    Early
    EarlyThis App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late'
    Late
    LateThis App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early'
    Manual
    ManualASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically
    UpgradePreferenceNone
    NoneNo preference on when this App Service Environment will be upgraded
    UpgradePreferenceEarly
    EarlyThis App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late'
    UpgradePreferenceLate
    LateThis App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early'
    UpgradePreferenceManual
    ManualASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically
    None
    NoneNo preference on when this App Service Environment will be upgraded
    Early
    EarlyThis App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late'
    Late
    LateThis App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early'
    Manual
    ManualASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically
    None
    NoneNo preference on when this App Service Environment will be upgraded
    Early
    EarlyThis App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late'
    Late
    LateThis App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early'
    Manual
    ManualASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically
    NONE
    NoneNo preference on when this App Service Environment will be upgraded
    EARLY
    EarlyThis App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late'
    LATE
    LateThis App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early'
    MANUAL
    ManualASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically
    "None"
    NoneNo preference on when this App Service Environment will be upgraded
    "Early"
    EarlyThis App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late'
    "Late"
    LateThis App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early'
    "Manual"
    ManualASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically

    VirtualNetworkProfile, VirtualNetworkProfileArgs

    Id string
    Resource id of the Virtual Network.
    Subnet string
    Subnet within the Virtual Network.
    Id string
    Resource id of the Virtual Network.
    Subnet string
    Subnet within the Virtual Network.
    id String
    Resource id of the Virtual Network.
    subnet String
    Subnet within the Virtual Network.
    id string
    Resource id of the Virtual Network.
    subnet string
    Subnet within the Virtual Network.
    id str
    Resource id of the Virtual Network.
    subnet str
    Subnet within the Virtual Network.
    id String
    Resource id of the Virtual Network.
    subnet String
    Subnet within the Virtual Network.

    VirtualNetworkProfileResponse, VirtualNetworkProfileResponseArgs

    Id string
    Resource id of the Virtual Network.
    Name string
    Name of the Virtual Network (read-only).
    Type string
    Resource type of the Virtual Network (read-only).
    Subnet string
    Subnet within the Virtual Network.
    Id string
    Resource id of the Virtual Network.
    Name string
    Name of the Virtual Network (read-only).
    Type string
    Resource type of the Virtual Network (read-only).
    Subnet string
    Subnet within the Virtual Network.
    id String
    Resource id of the Virtual Network.
    name String
    Name of the Virtual Network (read-only).
    type String
    Resource type of the Virtual Network (read-only).
    subnet String
    Subnet within the Virtual Network.
    id string
    Resource id of the Virtual Network.
    name string
    Name of the Virtual Network (read-only).
    type string
    Resource type of the Virtual Network (read-only).
    subnet string
    Subnet within the Virtual Network.
    id str
    Resource id of the Virtual Network.
    name str
    Name of the Virtual Network (read-only).
    type str
    Resource type of the Virtual Network (read-only).
    subnet str
    Subnet within the Virtual Network.
    id String
    Resource id of the Virtual Network.
    name String
    Name of the Virtual Network (read-only).
    type String
    Resource type of the Virtual Network (read-only).
    subnet String
    Subnet within the Virtual Network.

    Import

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

    $ pulumi import azure-native:web:AppServiceEnvironment test-ase /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-azure-native