Docs Packages
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. web
  5. AppServiceEnvironment
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.web.AppServiceEnvironment

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    App Service Environment ARM resource. API Version: 2020-12-01.

    Import

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

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

    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,
                          internal_load_balancing_mode: Optional[Union[str, LoadBalancingMode]] = None,
                          cluster_settings: Optional[Sequence[NameValuePairArgs]] = None,
                          ipssl_address_count: Optional[int] = None,
                          kind: Optional[str] = None,
                          location: Optional[str] = None,
                          multi_size: Optional[str] = None,
                          name: Optional[str] = None,
                          front_end_scale_factor: Optional[int] = None,
                          tags: Optional[Mapping[str, str]] = None,
                          user_whitelisted_ip_ranges: Optional[Sequence[str]] = None,
                          dns_suffix: Optional[str] = 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 = 
    {
        { "id", "string" },
        { "subnet", "string" },
    },
    InternalLoadBalancingMode = "string",
    ClusterSettings = new[]
    {
        
        {
            { "name", "string" },
            { "value", "string" },
        },
    },
    IpsslAddressCount = 0,
    Kind = "string",
    Location = "string",
    MultiSize = "string",
    Name = "string",
    FrontEndScaleFactor = 0,
    Tags = 
    {
        { "string", "string" },
    },
    UserWhitelistedIpRanges = new[]
    {
        "string",
    },
    DnsSuffix = "string",
});

    example, err := web.NewAppServiceEnvironment(ctx, "appServiceEnvironmentResource", &web.AppServiceEnvironmentArgs{
	ResourceGroupName: "string",
	VirtualNetwork: map[string]interface{}{
		"id":     "string",
		"subnet": "string",
	},
	InternalLoadBalancingMode: "string",
	ClusterSettings: []map[string]interface{}{
		map[string]interface{}{
			"name":  "string",
			"value": "string",
		},
	},
	IpsslAddressCount:   0,
	Kind:                "string",
	Location:            "string",
	MultiSize:           "string",
	Name:                "string",
	FrontEndScaleFactor: 0,
	Tags: map[string]interface{}{
		"string": "string",
	},
	UserWhitelistedIpRanges: []string{
		"string",
	},
	DnsSuffix: "string",
})

    var appServiceEnvironmentResource = new AppServiceEnvironment("appServiceEnvironmentResource", AppServiceEnvironmentArgs.builder()
    .resourceGroupName("string")
    .virtualNetwork(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .internalLoadBalancingMode("string")
    .clusterSettings(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .ipsslAddressCount(0)
    .kind("string")
    .location("string")
    .multiSize("string")
    .name("string")
    .frontEndScaleFactor(0)
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .userWhitelistedIpRanges("string")
    .dnsSuffix("string")
    .build());

    app_service_environment_resource = azure_native.web.AppServiceEnvironment("appServiceEnvironmentResource",
    resource_group_name=string,
    virtual_network={
        id: string,
        subnet: string,
    },
    internal_load_balancing_mode=string,
    cluster_settings=[{
        name: string,
        value: string,
    }],
    ipssl_address_count=0,
    kind=string,
    location=string,
    multi_size=string,
    name=string,
    front_end_scale_factor=0,
    tags={
        string: string,
    },
    user_whitelisted_ip_ranges=[string],
    dns_suffix=string)

    const appServiceEnvironmentResource = new azure_native.web.AppServiceEnvironment("appServiceEnvironmentResource", {
    resourceGroupName: "string",
    virtualNetwork: {
        id: "string",
        subnet: "string",
    },
    internalLoadBalancingMode: "string",
    clusterSettings: [{
        name: "string",
        value: "string",
    }],
    ipsslAddressCount: 0,
    kind: "string",
    location: "string",
    multiSize: "string",
    name: "string",
    frontEndScaleFactor: 0,
    tags: {
        string: "string",
    },
    userWhitelistedIpRanges: ["string"],
    dnsSuffix: "string",
});

    type: azure-native:web:AppServiceEnvironment
properties:
    clusterSettings:
        - name: string
          value: string
    dnsSuffix: string
    frontEndScaleFactor: 0
    internalLoadBalancingMode: string
    ipsslAddressCount: 0
    kind: string
    location: string
    multiSize: string
    name: string
    resourceGroupName: string
    tags:
        string: string
    userWhitelistedIpRanges:
        - string
    virtualNetwork:
        id: string
        subnet: string

    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

    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.
    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.
    Tags Dictionary<string, string>
    Resource tags.
    UserWhitelistedIpRanges List<string>
    User added list of IP Ranges allowed on ASE db
    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.
    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.
    Tags map[string]string
    Resource tags.
    UserWhitelistedIpRanges []string
    User added list of IP Ranges allowed on ASE db
    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.
    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.
    tags Map<String,String>
    Resource tags.
    userWhitelistedIpRanges List<String>
    User added list of IP Ranges allowed on ASE db
    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.
    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.
    tags {[key: string]: string}
    Resource tags.
    userWhitelistedIpRanges string[]
    User added list of IP Ranges allowed on ASE db
    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.
    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.
    tags Mapping[str, str]
    Resource tags.
    user_whitelisted_ip_ranges Sequence[str]
    User added list of IP Ranges allowed on ASE db
    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.
    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.
    tags Map<String>
    Resource tags.
    userWhitelistedIpRanges List<String>
    User added list of IP Ranges allowed on ASE db

    Outputs

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

    DedicatedHostCount int
    Dedicated Host Count
    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.
    DedicatedHostCount int
    Dedicated Host Count
    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.
    dedicatedHostCount Integer
    Dedicated Host Count
    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.
    dedicatedHostCount number
    Dedicated Host Count
    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.
    dedicated_host_count int
    Dedicated Host Count
    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.
    dedicatedHostCount Number
    Dedicated Host Count
    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.

    Supporting Types

    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.

    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.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native