Docs
PackagesWe recommend using Azure Native.
azure.appservice.Environment
Explore with Pulumi AI
Manages an App Service Environment.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "exampleRG1",
location: "West Europe",
});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("example", {
name: "example-vnet1",
location: example.location,
resourceGroupName: example.name,
addressSpaces: ["10.0.0.0/16"],
});
const ase = new azure.network.Subnet("ase", {
name: "asesubnet",
resourceGroupName: example.name,
virtualNetworkName: exampleVirtualNetwork.name,
addressPrefixes: ["10.0.1.0/24"],
});
const gateway = new azure.network.Subnet("gateway", {
name: "gatewaysubnet",
resourceGroupName: example.name,
virtualNetworkName: exampleVirtualNetwork.name,
addressPrefixes: ["10.0.2.0/24"],
});
const exampleEnvironment = new azure.appservice.Environment("example", {
name: "example-ase",
resourceGroupName: example.name,
subnetId: ase.id,
pricingTier: "I2",
frontEndScaleFactor: 10,
internalLoadBalancingMode: "Web, Publishing",
allowedUserIpCidrs: [
"11.22.33.44/32",
"55.66.77.0/24",
],
clusterSettings: [{
name: "DisableTls1.0",
value: "1",
}],
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="exampleRG1",
location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("example",
name="example-vnet1",
location=example.location,
resource_group_name=example.name,
address_spaces=["10.0.0.0/16"])
ase = azure.network.Subnet("ase",
name="asesubnet",
resource_group_name=example.name,
virtual_network_name=example_virtual_network.name,
address_prefixes=["10.0.1.0/24"])
gateway = azure.network.Subnet("gateway",
name="gatewaysubnet",
resource_group_name=example.name,
virtual_network_name=example_virtual_network.name,
address_prefixes=["10.0.2.0/24"])
example_environment = azure.appservice.Environment("example",
name="example-ase",
resource_group_name=example.name,
subnet_id=ase.id,
pricing_tier="I2",
front_end_scale_factor=10,
internal_load_balancing_mode="Web, Publishing",
allowed_user_ip_cidrs=[
"11.22.33.44/32",
"55.66.77.0/24",
],
cluster_settings=[azure.appservice.EnvironmentClusterSettingArgs(
name="DisableTls1.0",
value="1",
)])
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/appservice"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
"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("exampleRG1"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "example", &network.VirtualNetworkArgs{
Name: pulumi.String("example-vnet1"),
Location: example.Location,
ResourceGroupName: example.Name,
AddressSpaces: pulumi.StringArray{
pulumi.String("10.0.0.0/16"),
},
})
if err != nil {
return err
}
ase, err := network.NewSubnet(ctx, "ase", &network.SubnetArgs{
Name: pulumi.String("asesubnet"),
ResourceGroupName: example.Name,
VirtualNetworkName: exampleVirtualNetwork.Name,
AddressPrefixes: pulumi.StringArray{
pulumi.String("10.0.1.0/24"),
},
})
if err != nil {
return err
}
_, err = network.NewSubnet(ctx, "gateway", &network.SubnetArgs{
Name: pulumi.String("gatewaysubnet"),
ResourceGroupName: example.Name,
VirtualNetworkName: exampleVirtualNetwork.Name,
AddressPrefixes: pulumi.StringArray{
pulumi.String("10.0.2.0/24"),
},
})
if err != nil {
return err
}
_, err = appservice.NewEnvironment(ctx, "example", &appservice.EnvironmentArgs{
Name: pulumi.String("example-ase"),
ResourceGroupName: example.Name,
SubnetId: ase.ID(),
PricingTier: pulumi.String("I2"),
FrontEndScaleFactor: pulumi.Int(10),
InternalLoadBalancingMode: pulumi.String("Web, Publishing"),
AllowedUserIpCidrs: pulumi.StringArray{
pulumi.String("11.22.33.44/32"),
pulumi.String("55.66.77.0/24"),
},
ClusterSettings: appservice.EnvironmentClusterSettingArray{
&appservice.EnvironmentClusterSettingArgs{
Name: pulumi.String("DisableTls1.0"),
Value: pulumi.String("1"),
},
},
})
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 = "exampleRG1",
Location = "West Europe",
});
var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("example", new()
{
Name = "example-vnet1",
Location = example.Location,
ResourceGroupName = example.Name,
AddressSpaces = new[]
{
"10.0.0.0/16",
},
});
var ase = new Azure.Network.Subnet("ase", new()
{
Name = "asesubnet",
ResourceGroupName = example.Name,
VirtualNetworkName = exampleVirtualNetwork.Name,
AddressPrefixes = new[]
{
"10.0.1.0/24",
},
});
var gateway = new Azure.Network.Subnet("gateway", new()
{
Name = "gatewaysubnet",
ResourceGroupName = example.Name,
VirtualNetworkName = exampleVirtualNetwork.Name,
AddressPrefixes = new[]
{
"10.0.2.0/24",
},
});
var exampleEnvironment = new Azure.AppService.Environment("example", new()
{
Name = "example-ase",
ResourceGroupName = example.Name,
SubnetId = ase.Id,
PricingTier = "I2",
FrontEndScaleFactor = 10,
InternalLoadBalancingMode = "Web, Publishing",
AllowedUserIpCidrs = new[]
{
"11.22.33.44/32",
"55.66.77.0/24",
},
ClusterSettings = new[]
{
new Azure.AppService.Inputs.EnvironmentClusterSettingArgs
{
Name = "DisableTls1.0",
Value = "1",
},
},
});
});
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.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.Subnet;
import com.pulumi.azure.network.SubnetArgs;
import com.pulumi.azure.appservice.Environment;
import com.pulumi.azure.appservice.EnvironmentArgs;
import com.pulumi.azure.appservice.inputs.EnvironmentClusterSettingArgs;
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("exampleRG1")
.location("West Europe")
.build());
var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
.name("example-vnet1")
.location(example.location())
.resourceGroupName(example.name())
.addressSpaces("10.0.0.0/16")
.build());
var ase = new Subnet("ase", SubnetArgs.builder()
.name("asesubnet")
.resourceGroupName(example.name())
.virtualNetworkName(exampleVirtualNetwork.name())
.addressPrefixes("10.0.1.0/24")
.build());
var gateway = new Subnet("gateway", SubnetArgs.builder()
.name("gatewaysubnet")
.resourceGroupName(example.name())
.virtualNetworkName(exampleVirtualNetwork.name())
.addressPrefixes("10.0.2.0/24")
.build());
var exampleEnvironment = new Environment("exampleEnvironment", EnvironmentArgs.builder()
.name("example-ase")
.resourceGroupName(example.name())
.subnetId(ase.id())
.pricingTier("I2")
.frontEndScaleFactor(10)
.internalLoadBalancingMode("Web, Publishing")
.allowedUserIpCidrs(
"11.22.33.44/32",
"55.66.77.0/24")
.clusterSettings(EnvironmentClusterSettingArgs.builder()
.name("DisableTls1.0")
.value("1")
.build())
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: exampleRG1
location: West Europe
exampleVirtualNetwork:
type: azure:network:VirtualNetwork
name: example
properties:
name: example-vnet1
location: ${example.location}
resourceGroupName: ${example.name}
addressSpaces:
- 10.0.0.0/16
ase:
type: azure:network:Subnet
properties:
name: asesubnet
resourceGroupName: ${example.name}
virtualNetworkName: ${exampleVirtualNetwork.name}
addressPrefixes:
- 10.0.1.0/24
gateway:
type: azure:network:Subnet
properties:
name: gatewaysubnet
resourceGroupName: ${example.name}
virtualNetworkName: ${exampleVirtualNetwork.name}
addressPrefixes:
- 10.0.2.0/24
exampleEnvironment:
type: azure:appservice:Environment
name: example
properties:
name: example-ase
resourceGroupName: ${example.name}
subnetId: ${ase.id}
pricingTier: I2
frontEndScaleFactor: 10
internalLoadBalancingMode: Web, Publishing
allowedUserIpCidrs:
- 11.22.33.44/32
- 55.66.77.0/24
clusterSettings:
- name: DisableTls1.0
value: '1'
Create Environment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Environment(name: string, args: EnvironmentArgs, opts?: CustomResourceOptions);@overload
def Environment(resource_name: str,
args: EnvironmentArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Environment(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
subnet_id: Optional[str] = None,
allowed_user_ip_cidrs: Optional[Sequence[str]] = None,
cluster_settings: Optional[Sequence[EnvironmentClusterSettingArgs]] = None,
front_end_scale_factor: Optional[int] = None,
internal_load_balancing_mode: Optional[str] = None,
name: Optional[str] = None,
pricing_tier: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)func NewEnvironment(ctx *Context, name string, args EnvironmentArgs, opts ...ResourceOption) (*Environment, error)public Environment(string name, EnvironmentArgs args, CustomResourceOptions? opts = null)
public Environment(String name, EnvironmentArgs args)
public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)
type: azure:appservice:Environment
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 EnvironmentArgs
- 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 EnvironmentArgs
- 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 EnvironmentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EnvironmentArgs
- 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 environmentResource = new Azure.AppService.Environment("environmentResource", new()
{
ResourceGroupName = "string",
SubnetId = "string",
AllowedUserIpCidrs = new[]
{
"string",
},
ClusterSettings = new[]
{
new Azure.AppService.Inputs.EnvironmentClusterSettingArgs
{
Name = "string",
Value = "string",
},
},
FrontEndScaleFactor = 0,
InternalLoadBalancingMode = "string",
Name = "string",
PricingTier = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := appservice.NewEnvironment(ctx, "environmentResource", &appservice.EnvironmentArgs{
ResourceGroupName: pulumi.String("string"),
SubnetId: pulumi.String("string"),
AllowedUserIpCidrs: pulumi.StringArray{
pulumi.String("string"),
},
ClusterSettings: appservice.EnvironmentClusterSettingArray{
&appservice.EnvironmentClusterSettingArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
FrontEndScaleFactor: pulumi.Int(0),
InternalLoadBalancingMode: pulumi.String("string"),
Name: pulumi.String("string"),
PricingTier: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var environmentResource = new Environment("environmentResource", EnvironmentArgs.builder()
.resourceGroupName("string")
.subnetId("string")
.allowedUserIpCidrs("string")
.clusterSettings(EnvironmentClusterSettingArgs.builder()
.name("string")
.value("string")
.build())
.frontEndScaleFactor(0)
.internalLoadBalancingMode("string")
.name("string")
.pricingTier("string")
.tags(Map.of("string", "string"))
.build());
environment_resource = azure.appservice.Environment("environmentResource",
resource_group_name="string",
subnet_id="string",
allowed_user_ip_cidrs=["string"],
cluster_settings=[azure.appservice.EnvironmentClusterSettingArgs(
name="string",
value="string",
)],
front_end_scale_factor=0,
internal_load_balancing_mode="string",
name="string",
pricing_tier="string",
tags={
"string": "string",
})
const environmentResource = new azure.appservice.Environment("environmentResource", {
resourceGroupName: "string",
subnetId: "string",
allowedUserIpCidrs: ["string"],
clusterSettings: [{
name: "string",
value: "string",
}],
frontEndScaleFactor: 0,
internalLoadBalancingMode: "string",
name: "string",
pricingTier: "string",
tags: {
string: "string",
},
});
type: azure:appservice:Environment
properties:
allowedUserIpCidrs:
- string
clusterSettings:
- name: string
value: string
frontEndScaleFactor: 0
internalLoadBalancingMode: string
name: string
pricingTier: string
resourceGroupName: string
subnetId: string
tags:
string: string
Environment 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 Environment resource accepts the following input properties:
- Resource
Group stringName - The name of the Resource Group where the App Service Environment exists. Defaults to the Resource Group of the Subnet (specified by
subnet_id). - Subnet
Id string The ID of the Subnet which the App Service Environment should be connected to. Changing this forces a new resource to be created.
NOTE a /24 or larger CIDR is required. Once associated with an ASE this size cannot be changed.
- Allowed
User List<string>Ip Cidrs Allowed user added IP ranges on the ASE database. Use the addresses you want to set as the explicit egress address ranges.
NOTE:
allowed_user_ip_cidrsThe addresses that will be used for all outbound traffic from your App Service Environment to the internet to avoid asymmetric routing challenge. If you're routing the traffic on premises, these addresses are your NATs or gateway IPs. If you want to route the App Service Environment outbound traffic through an NVA, the egress address is the public IP of the NVA. Please visit Create your ASE with the egress addresses- Cluster
Settings List<EnvironmentCluster Setting> - Zero or more
cluster_settingblocks as defined below. - Front
End intScale Factor - Scale factor for front end instances. Possible values are between
5and15. Defaults to15. - Internal
Load stringBalancing Mode - Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values are
None,Web,Publishingand combined value"Web, Publishing". Defaults toNone. Changing this forces a new resource to be created. - Name string
- The name of the App Service Environment. Changing this forces a new resource to be created.
- Pricing
Tier string - Pricing tier for the front end instances. Possible values are
I1,I2andI3. Defaults toI1. - Dictionary<string, string>
- A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
- Resource
Group stringName - The name of the Resource Group where the App Service Environment exists. Defaults to the Resource Group of the Subnet (specified by
subnet_id). - Subnet
Id string The ID of the Subnet which the App Service Environment should be connected to. Changing this forces a new resource to be created.
NOTE a /24 or larger CIDR is required. Once associated with an ASE this size cannot be changed.
- Allowed
User []stringIp Cidrs Allowed user added IP ranges on the ASE database. Use the addresses you want to set as the explicit egress address ranges.
NOTE:
allowed_user_ip_cidrsThe addresses that will be used for all outbound traffic from your App Service Environment to the internet to avoid asymmetric routing challenge. If you're routing the traffic on premises, these addresses are your NATs or gateway IPs. If you want to route the App Service Environment outbound traffic through an NVA, the egress address is the public IP of the NVA. Please visit Create your ASE with the egress addresses- Cluster
Settings []EnvironmentCluster Setting Args - Zero or more
cluster_settingblocks as defined below. - Front
End intScale Factor - Scale factor for front end instances. Possible values are between
5and15. Defaults to15. - Internal
Load stringBalancing Mode - Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values are
None,Web,Publishingand combined value"Web, Publishing". Defaults toNone. Changing this forces a new resource to be created. - Name string
- The name of the App Service Environment. Changing this forces a new resource to be created.
- Pricing
Tier string - Pricing tier for the front end instances. Possible values are
I1,I2andI3. Defaults toI1. - map[string]string
- A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
- resource
Group StringName - The name of the Resource Group where the App Service Environment exists. Defaults to the Resource Group of the Subnet (specified by
subnet_id). - subnet
Id String The ID of the Subnet which the App Service Environment should be connected to. Changing this forces a new resource to be created.
NOTE a /24 or larger CIDR is required. Once associated with an ASE this size cannot be changed.
- allowed
User List<String>Ip Cidrs Allowed user added IP ranges on the ASE database. Use the addresses you want to set as the explicit egress address ranges.
NOTE:
allowed_user_ip_cidrsThe addresses that will be used for all outbound traffic from your App Service Environment to the internet to avoid asymmetric routing challenge. If you're routing the traffic on premises, these addresses are your NATs or gateway IPs. If you want to route the App Service Environment outbound traffic through an NVA, the egress address is the public IP of the NVA. Please visit Create your ASE with the egress addresses- cluster
Settings List<EnvironmentCluster Setting> - Zero or more
cluster_settingblocks as defined below. - front
End IntegerScale Factor - Scale factor for front end instances. Possible values are between
5and15. Defaults to15. - internal
Load StringBalancing Mode - Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values are
None,Web,Publishingand combined value"Web, Publishing". Defaults toNone. Changing this forces a new resource to be created. - name String
- The name of the App Service Environment. Changing this forces a new resource to be created.
- pricing
Tier String - Pricing tier for the front end instances. Possible values are
I1,I2andI3. Defaults toI1. - Map<String,String>
- A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
- resource
Group stringName - The name of the Resource Group where the App Service Environment exists. Defaults to the Resource Group of the Subnet (specified by
subnet_id). - subnet
Id string The ID of the Subnet which the App Service Environment should be connected to. Changing this forces a new resource to be created.
NOTE a /24 or larger CIDR is required. Once associated with an ASE this size cannot be changed.
- allowed
User string[]Ip Cidrs Allowed user added IP ranges on the ASE database. Use the addresses you want to set as the explicit egress address ranges.
NOTE:
allowed_user_ip_cidrsThe addresses that will be used for all outbound traffic from your App Service Environment to the internet to avoid asymmetric routing challenge. If you're routing the traffic on premises, these addresses are your NATs or gateway IPs. If you want to route the App Service Environment outbound traffic through an NVA, the egress address is the public IP of the NVA. Please visit Create your ASE with the egress addresses- cluster
Settings EnvironmentCluster Setting[] - Zero or more
cluster_settingblocks as defined below. - front
End numberScale Factor - Scale factor for front end instances. Possible values are between
5and15. Defaults to15. - internal
Load stringBalancing Mode - Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values are
None,Web,Publishingand combined value"Web, Publishing". Defaults toNone. Changing this forces a new resource to be created. - name string
- The name of the App Service Environment. Changing this forces a new resource to be created.
- pricing
Tier string - Pricing tier for the front end instances. Possible values are
I1,I2andI3. Defaults toI1. - {[key: string]: string}
- A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
- resource_
group_ strname - The name of the Resource Group where the App Service Environment exists. Defaults to the Resource Group of the Subnet (specified by
subnet_id). - subnet_
id str The ID of the Subnet which the App Service Environment should be connected to. Changing this forces a new resource to be created.
NOTE a /24 or larger CIDR is required. Once associated with an ASE this size cannot be changed.
- allowed_
user_ Sequence[str]ip_ cidrs Allowed user added IP ranges on the ASE database. Use the addresses you want to set as the explicit egress address ranges.
NOTE:
allowed_user_ip_cidrsThe addresses that will be used for all outbound traffic from your App Service Environment to the internet to avoid asymmetric routing challenge. If you're routing the traffic on premises, these addresses are your NATs or gateway IPs. If you want to route the App Service Environment outbound traffic through an NVA, the egress address is the public IP of the NVA. Please visit Create your ASE with the egress addresses- cluster_
settings Sequence[EnvironmentCluster Setting Args] - Zero or more
cluster_settingblocks as defined below. - front_
end_ intscale_ factor - Scale factor for front end instances. Possible values are between
5and15. Defaults to15. - internal_
load_ strbalancing_ mode - Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values are
None,Web,Publishingand combined value"Web, Publishing". Defaults toNone. Changing this forces a new resource to be created. - name str
- The name of the App Service Environment. Changing this forces a new resource to be created.
- pricing_
tier str - Pricing tier for the front end instances. Possible values are
I1,I2andI3. Defaults toI1. - Mapping[str, str]
- A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
- resource
Group StringName - The name of the Resource Group where the App Service Environment exists. Defaults to the Resource Group of the Subnet (specified by
subnet_id). - subnet
Id String The ID of the Subnet which the App Service Environment should be connected to. Changing this forces a new resource to be created.
NOTE a /24 or larger CIDR is required. Once associated with an ASE this size cannot be changed.
- allowed
User List<String>Ip Cidrs Allowed user added IP ranges on the ASE database. Use the addresses you want to set as the explicit egress address ranges.
NOTE:
allowed_user_ip_cidrsThe addresses that will be used for all outbound traffic from your App Service Environment to the internet to avoid asymmetric routing challenge. If you're routing the traffic on premises, these addresses are your NATs or gateway IPs. If you want to route the App Service Environment outbound traffic through an NVA, the egress address is the public IP of the NVA. Please visit Create your ASE with the egress addresses- cluster
Settings List<Property Map> - Zero or more
cluster_settingblocks as defined below. - front
End NumberScale Factor - Scale factor for front end instances. Possible values are between
5and15. Defaults to15. - internal
Load StringBalancing Mode - Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values are
None,Web,Publishingand combined value"Web, Publishing". Defaults toNone. Changing this forces a new resource to be created. - name String
- The name of the App Service Environment. Changing this forces a new resource to be created.
- pricing
Tier String - Pricing tier for the front end instances. Possible values are
I1,I2andI3. Defaults toI1. - Map<String>
- A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the Environment resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Internal
Ip stringAddress - IP address of internal load balancer of the App Service Environment.
- Location string
- The location where the App Service Environment exists.
- Outbound
Ip List<string>Addresses - List of outbound IP addresses of the App Service Environment.
- Service
Ip stringAddress - IP address of service endpoint of the App Service Environment.
- Id string
- The provider-assigned unique ID for this managed resource.
- Internal
Ip stringAddress - IP address of internal load balancer of the App Service Environment.
- Location string
- The location where the App Service Environment exists.
- Outbound
Ip []stringAddresses - List of outbound IP addresses of the App Service Environment.
- Service
Ip stringAddress - IP address of service endpoint of the App Service Environment.
- id String
- The provider-assigned unique ID for this managed resource.
- internal
Ip StringAddress - IP address of internal load balancer of the App Service Environment.
- location String
- The location where the App Service Environment exists.
- outbound
Ip List<String>Addresses - List of outbound IP addresses of the App Service Environment.
- service
Ip StringAddress - IP address of service endpoint of the App Service Environment.
- id string
- The provider-assigned unique ID for this managed resource.
- internal
Ip stringAddress - IP address of internal load balancer of the App Service Environment.
- location string
- The location where the App Service Environment exists.
- outbound
Ip string[]Addresses - List of outbound IP addresses of the App Service Environment.
- service
Ip stringAddress - IP address of service endpoint of the App Service Environment.
- id str
- The provider-assigned unique ID for this managed resource.
- internal_
ip_ straddress - IP address of internal load balancer of the App Service Environment.
- location str
- The location where the App Service Environment exists.
- outbound_
ip_ Sequence[str]addresses - List of outbound IP addresses of the App Service Environment.
- service_
ip_ straddress - IP address of service endpoint of the App Service Environment.
- id String
- The provider-assigned unique ID for this managed resource.
- internal
Ip StringAddress - IP address of internal load balancer of the App Service Environment.
- location String
- The location where the App Service Environment exists.
- outbound
Ip List<String>Addresses - List of outbound IP addresses of the App Service Environment.
- service
Ip StringAddress - IP address of service endpoint of the App Service Environment.
Look up Existing Environment Resource
Get an existing Environment 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?: EnvironmentState, opts?: CustomResourceOptions): Environment@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allowed_user_ip_cidrs: Optional[Sequence[str]] = None,
cluster_settings: Optional[Sequence[EnvironmentClusterSettingArgs]] = None,
front_end_scale_factor: Optional[int] = None,
internal_ip_address: Optional[str] = None,
internal_load_balancing_mode: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
outbound_ip_addresses: Optional[Sequence[str]] = None,
pricing_tier: Optional[str] = None,
resource_group_name: Optional[str] = None,
service_ip_address: Optional[str] = None,
subnet_id: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None) -> Environmentfunc GetEnvironment(ctx *Context, name string, id IDInput, state *EnvironmentState, opts ...ResourceOption) (*Environment, error)public static Environment Get(string name, Input<string> id, EnvironmentState? state, CustomResourceOptions? opts = null)public static Environment get(String name, Output<String> id, EnvironmentState 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.
- Allowed
User List<string>Ip Cidrs Allowed user added IP ranges on the ASE database. Use the addresses you want to set as the explicit egress address ranges.
NOTE:
allowed_user_ip_cidrsThe addresses that will be used for all outbound traffic from your App Service Environment to the internet to avoid asymmetric routing challenge. If you're routing the traffic on premises, these addresses are your NATs or gateway IPs. If you want to route the App Service Environment outbound traffic through an NVA, the egress address is the public IP of the NVA. Please visit Create your ASE with the egress addresses- Cluster
Settings List<EnvironmentCluster Setting> - Zero or more
cluster_settingblocks as defined below. - Front
End intScale Factor - Scale factor for front end instances. Possible values are between
5and15. Defaults to15. - Internal
Ip stringAddress - IP address of internal load balancer of the App Service Environment.
- Internal
Load stringBalancing Mode - Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values are
None,Web,Publishingand combined value"Web, Publishing". Defaults toNone. Changing this forces a new resource to be created. - Location string
- The location where the App Service Environment exists.
- Name string
- The name of the App Service Environment. Changing this forces a new resource to be created.
- Outbound
Ip List<string>Addresses - List of outbound IP addresses of the App Service Environment.
- Pricing
Tier string - Pricing tier for the front end instances. Possible values are
I1,I2andI3. Defaults toI1. - Resource
Group stringName - The name of the Resource Group where the App Service Environment exists. Defaults to the Resource Group of the Subnet (specified by
subnet_id). - Service
Ip stringAddress - IP address of service endpoint of the App Service Environment.
- Subnet
Id string The ID of the Subnet which the App Service Environment should be connected to. Changing this forces a new resource to be created.
NOTE a /24 or larger CIDR is required. Once associated with an ASE this size cannot be changed.
- Dictionary<string, string>
- A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
- Allowed
User []stringIp Cidrs Allowed user added IP ranges on the ASE database. Use the addresses you want to set as the explicit egress address ranges.
NOTE:
allowed_user_ip_cidrsThe addresses that will be used for all outbound traffic from your App Service Environment to the internet to avoid asymmetric routing challenge. If you're routing the traffic on premises, these addresses are your NATs or gateway IPs. If you want to route the App Service Environment outbound traffic through an NVA, the egress address is the public IP of the NVA. Please visit Create your ASE with the egress addresses- Cluster
Settings []EnvironmentCluster Setting Args - Zero or more
cluster_settingblocks as defined below. - Front
End intScale Factor - Scale factor for front end instances. Possible values are between
5and15. Defaults to15. - Internal
Ip stringAddress - IP address of internal load balancer of the App Service Environment.
- Internal
Load stringBalancing Mode - Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values are
None,Web,Publishingand combined value"Web, Publishing". Defaults toNone. Changing this forces a new resource to be created. - Location string
- The location where the App Service Environment exists.
- Name string
- The name of the App Service Environment. Changing this forces a new resource to be created.
- Outbound
Ip []stringAddresses - List of outbound IP addresses of the App Service Environment.
- Pricing
Tier string - Pricing tier for the front end instances. Possible values are
I1,I2andI3. Defaults toI1. - Resource
Group stringName - The name of the Resource Group where the App Service Environment exists. Defaults to the Resource Group of the Subnet (specified by
subnet_id). - Service
Ip stringAddress - IP address of service endpoint of the App Service Environment.
- Subnet
Id string The ID of the Subnet which the App Service Environment should be connected to. Changing this forces a new resource to be created.
NOTE a /24 or larger CIDR is required. Once associated with an ASE this size cannot be changed.
- map[string]string
- A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
- allowed
User List<String>Ip Cidrs Allowed user added IP ranges on the ASE database. Use the addresses you want to set as the explicit egress address ranges.
NOTE:
allowed_user_ip_cidrsThe addresses that will be used for all outbound traffic from your App Service Environment to the internet to avoid asymmetric routing challenge. If you're routing the traffic on premises, these addresses are your NATs or gateway IPs. If you want to route the App Service Environment outbound traffic through an NVA, the egress address is the public IP of the NVA. Please visit Create your ASE with the egress addresses- cluster
Settings List<EnvironmentCluster Setting> - Zero or more
cluster_settingblocks as defined below. - front
End IntegerScale Factor - Scale factor for front end instances. Possible values are between
5and15. Defaults to15. - internal
Ip StringAddress - IP address of internal load balancer of the App Service Environment.
- internal
Load StringBalancing Mode - Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values are
None,Web,Publishingand combined value"Web, Publishing". Defaults toNone. Changing this forces a new resource to be created. - location String
- The location where the App Service Environment exists.
- name String
- The name of the App Service Environment. Changing this forces a new resource to be created.
- outbound
Ip List<String>Addresses - List of outbound IP addresses of the App Service Environment.
- pricing
Tier String - Pricing tier for the front end instances. Possible values are
I1,I2andI3. Defaults toI1. - resource
Group StringName - The name of the Resource Group where the App Service Environment exists. Defaults to the Resource Group of the Subnet (specified by
subnet_id). - service
Ip StringAddress - IP address of service endpoint of the App Service Environment.
- subnet
Id String The ID of the Subnet which the App Service Environment should be connected to. Changing this forces a new resource to be created.
NOTE a /24 or larger CIDR is required. Once associated with an ASE this size cannot be changed.
- Map<String,String>
- A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
- allowed
User string[]Ip Cidrs Allowed user added IP ranges on the ASE database. Use the addresses you want to set as the explicit egress address ranges.
NOTE:
allowed_user_ip_cidrsThe addresses that will be used for all outbound traffic from your App Service Environment to the internet to avoid asymmetric routing challenge. If you're routing the traffic on premises, these addresses are your NATs or gateway IPs. If you want to route the App Service Environment outbound traffic through an NVA, the egress address is the public IP of the NVA. Please visit Create your ASE with the egress addresses- cluster
Settings EnvironmentCluster Setting[] - Zero or more
cluster_settingblocks as defined below. - front
End numberScale Factor - Scale factor for front end instances. Possible values are between
5and15. Defaults to15. - internal
Ip stringAddress - IP address of internal load balancer of the App Service Environment.
- internal
Load stringBalancing Mode - Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values are
None,Web,Publishingand combined value"Web, Publishing". Defaults toNone. Changing this forces a new resource to be created. - location string
- The location where the App Service Environment exists.
- name string
- The name of the App Service Environment. Changing this forces a new resource to be created.
- outbound
Ip string[]Addresses - List of outbound IP addresses of the App Service Environment.
- pricing
Tier string - Pricing tier for the front end instances. Possible values are
I1,I2andI3. Defaults toI1. - resource
Group stringName - The name of the Resource Group where the App Service Environment exists. Defaults to the Resource Group of the Subnet (specified by
subnet_id). - service
Ip stringAddress - IP address of service endpoint of the App Service Environment.
- subnet
Id string The ID of the Subnet which the App Service Environment should be connected to. Changing this forces a new resource to be created.
NOTE a /24 or larger CIDR is required. Once associated with an ASE this size cannot be changed.
- {[key: string]: string}
- A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
- allowed_
user_ Sequence[str]ip_ cidrs Allowed user added IP ranges on the ASE database. Use the addresses you want to set as the explicit egress address ranges.
NOTE:
allowed_user_ip_cidrsThe addresses that will be used for all outbound traffic from your App Service Environment to the internet to avoid asymmetric routing challenge. If you're routing the traffic on premises, these addresses are your NATs or gateway IPs. If you want to route the App Service Environment outbound traffic through an NVA, the egress address is the public IP of the NVA. Please visit Create your ASE with the egress addresses- cluster_
settings Sequence[EnvironmentCluster Setting Args] - Zero or more
cluster_settingblocks as defined below. - front_
end_ intscale_ factor - Scale factor for front end instances. Possible values are between
5and15. Defaults to15. - internal_
ip_ straddress - IP address of internal load balancer of the App Service Environment.
- internal_
load_ strbalancing_ mode - Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values are
None,Web,Publishingand combined value"Web, Publishing". Defaults toNone. Changing this forces a new resource to be created. - location str
- The location where the App Service Environment exists.
- name str
- The name of the App Service Environment. Changing this forces a new resource to be created.
- outbound_
ip_ Sequence[str]addresses - List of outbound IP addresses of the App Service Environment.
- pricing_
tier str - Pricing tier for the front end instances. Possible values are
I1,I2andI3. Defaults toI1. - resource_
group_ strname - The name of the Resource Group where the App Service Environment exists. Defaults to the Resource Group of the Subnet (specified by
subnet_id). - service_
ip_ straddress - IP address of service endpoint of the App Service Environment.
- subnet_
id str The ID of the Subnet which the App Service Environment should be connected to. Changing this forces a new resource to be created.
NOTE a /24 or larger CIDR is required. Once associated with an ASE this size cannot be changed.
- Mapping[str, str]
- A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
- allowed
User List<String>Ip Cidrs Allowed user added IP ranges on the ASE database. Use the addresses you want to set as the explicit egress address ranges.
NOTE:
allowed_user_ip_cidrsThe addresses that will be used for all outbound traffic from your App Service Environment to the internet to avoid asymmetric routing challenge. If you're routing the traffic on premises, these addresses are your NATs or gateway IPs. If you want to route the App Service Environment outbound traffic through an NVA, the egress address is the public IP of the NVA. Please visit Create your ASE with the egress addresses- cluster
Settings List<Property Map> - Zero or more
cluster_settingblocks as defined below. - front
End NumberScale Factor - Scale factor for front end instances. Possible values are between
5and15. Defaults to15. - internal
Ip StringAddress - IP address of internal load balancer of the App Service Environment.
- internal
Load StringBalancing Mode - Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values are
None,Web,Publishingand combined value"Web, Publishing". Defaults toNone. Changing this forces a new resource to be created. - location String
- The location where the App Service Environment exists.
- name String
- The name of the App Service Environment. Changing this forces a new resource to be created.
- outbound
Ip List<String>Addresses - List of outbound IP addresses of the App Service Environment.
- pricing
Tier String - Pricing tier for the front end instances. Possible values are
I1,I2andI3. Defaults toI1. - resource
Group StringName - The name of the Resource Group where the App Service Environment exists. Defaults to the Resource Group of the Subnet (specified by
subnet_id). - service
Ip StringAddress - IP address of service endpoint of the App Service Environment.
- subnet
Id String The ID of the Subnet which the App Service Environment should be connected to. Changing this forces a new resource to be created.
NOTE a /24 or larger CIDR is required. Once associated with an ASE this size cannot be changed.
- Map<String>
- A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
Supporting Types
EnvironmentClusterSetting, EnvironmentClusterSettingArgs
Import
The App Service Environment can be imported using the resource id, e.g.
$ pulumi import azure:appservice/environment:Environment myAppServiceEnv /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Web/hostingEnvironments/myAppServiceEnv
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.