Azure Native v1.102.0, May 2 23
Azure Native v1.102.0, May 2 23
azure-native.web.AppServiceEnvironment
Explore with Pulumi AI
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
new AppServiceEnvironment(name: string, args: AppServiceEnvironmentArgs, opts?: CustomResourceOptions);
@overload
def AppServiceEnvironment(resource_name: str,
opts: Optional[ResourceOptions] = None,
cluster_settings: Optional[Sequence[NameValuePairArgs]] = None,
dns_suffix: Optional[str] = None,
front_end_scale_factor: Optional[int] = None,
internal_load_balancing_mode: Optional[Union[str, LoadBalancingMode]] = None,
ipssl_address_count: Optional[int] = None,
kind: Optional[str] = None,
location: Optional[str] = None,
multi_size: Optional[str] = None,
name: Optional[str] = None,
resource_group_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
user_whitelisted_ip_ranges: Optional[Sequence[str]] = None,
virtual_network: Optional[VirtualNetworkProfileArgs] = None)
@overload
def AppServiceEnvironment(resource_name: str,
args: AppServiceEnvironmentArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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:
- Resource
Group stringName Name of the resource group to which the resource belongs.
- Virtual
Network Pulumi.Azure Native. Web. Inputs. Virtual Network Profile Args Description of the Virtual Network.
- Cluster
Settings List<Pulumi.Azure Native. Web. Inputs. Name Value Pair Args> Custom settings for changing the behavior of the App Service Environment.
- Dns
Suffix string DNS suffix of the App Service Environment.
- Front
End intScale Factor Scale factor for front-ends.
- Internal
Load string | Pulumi.Balancing Mode Azure Native. Web. Load Balancing Mode Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
- Ipssl
Address intCount Number of IP SSL addresses reserved for the App Service Environment.
- Kind string
Kind of resource.
- Location string
Resource Location.
- Multi
Size string Front-end VM size, e.g. "Medium", "Large".
- Name string
Name of the App Service Environment.
- Dictionary<string, string>
Resource tags.
- User
Whitelisted List<string>Ip Ranges User added list of IP Ranges allowed on ASE db
- Resource
Group stringName Name of the resource group to which the resource belongs.
- Virtual
Network VirtualNetwork Profile Args Description of the Virtual Network.
- Cluster
Settings []NameValue Pair Args Custom settings for changing the behavior of the App Service Environment.
- Dns
Suffix string DNS suffix of the App Service Environment.
- Front
End intScale Factor Scale factor for front-ends.
- Internal
Load string | LoadBalancing Mode Balancing Mode Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
- Ipssl
Address intCount Number of IP SSL addresses reserved for the App Service Environment.
- Kind string
Kind of resource.
- Location string
Resource Location.
- Multi
Size string Front-end VM size, e.g. "Medium", "Large".
- Name string
Name of the App Service Environment.
- map[string]string
Resource tags.
- User
Whitelisted []stringIp Ranges User added list of IP Ranges allowed on ASE db
- resource
Group StringName Name of the resource group to which the resource belongs.
- virtual
Network VirtualNetwork Profile Args Description of the Virtual Network.
- cluster
Settings List<NameValue Pair Args> Custom settings for changing the behavior of the App Service Environment.
- dns
Suffix String DNS suffix of the App Service Environment.
- front
End IntegerScale Factor Scale factor for front-ends.
- internal
Load String | LoadBalancing Mode Balancing Mode Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
- ipssl
Address IntegerCount Number of IP SSL addresses reserved for the App Service Environment.
- kind String
Kind of resource.
- location String
Resource Location.
- multi
Size String Front-end VM size, e.g. "Medium", "Large".
- name String
Name of the App Service Environment.
- Map<String,String>
Resource tags.
- user
Whitelisted List<String>Ip Ranges User added list of IP Ranges allowed on ASE db
- resource
Group stringName Name of the resource group to which the resource belongs.
- virtual
Network VirtualNetwork Profile Args Description of the Virtual Network.
- cluster
Settings NameValue Pair Args[] Custom settings for changing the behavior of the App Service Environment.
- dns
Suffix string DNS suffix of the App Service Environment.
- front
End numberScale Factor Scale factor for front-ends.
- internal
Load string | LoadBalancing Mode Balancing Mode Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
- ipssl
Address numberCount Number of IP SSL addresses reserved for the App Service Environment.
- kind string
Kind of resource.
- location string
Resource Location.
- multi
Size string Front-end VM size, e.g. "Medium", "Large".
- name string
Name of the App Service Environment.
- {[key: string]: string}
Resource tags.
- user
Whitelisted string[]Ip Ranges User added list of IP Ranges allowed on ASE db
- resource_
group_ strname Name of the resource group to which the resource belongs.
- virtual_
network VirtualNetwork Profile Args Description of the Virtual Network.
- cluster_
settings Sequence[NameValue Pair Args] Custom settings for changing the behavior of the App Service Environment.
- dns_
suffix str DNS suffix of the App Service Environment.
- front_
end_ intscale_ factor Scale factor for front-ends.
- internal_
load_ str | Loadbalancing_ mode Balancing Mode Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
- ipssl_
address_ intcount 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.
- Mapping[str, str]
Resource tags.
- user_
whitelisted_ Sequence[str]ip_ ranges User added list of IP Ranges allowed on ASE db
- resource
Group StringName Name of the resource group to which the resource belongs.
- virtual
Network Property Map Description of the Virtual Network.
- cluster
Settings List<Property Map> Custom settings for changing the behavior of the App Service Environment.
- dns
Suffix String DNS suffix of the App Service Environment.
- front
End NumberScale Factor Scale factor for front-ends.
- internal
Load String | "None" | "Web" | "Publishing" | "Web, Publishing"Balancing Mode Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
- ipssl
Address NumberCount Number of IP SSL addresses reserved for the App Service Environment.
- kind String
Kind of resource.
- location String
Resource Location.
- multi
Size String Front-end VM size, e.g. "Medium", "Large".
- name String
Name of the App Service Environment.
- Map<String>
Resource tags.
- user
Whitelisted List<String>Ip Ranges 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:
- Dedicated
Host intCount Dedicated Host Count
- Has
Linux boolWorkers Flag that displays whether an ASE has linux workers or not
- Id string
The provider-assigned unique ID for this managed resource.
- Maximum
Number intOf Machines Maximum number of VMs in the App Service Environment.
- Multi
Role intCount Number of front-end instances.
- Provisioning
State 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.
- Dedicated
Host intCount Dedicated Host Count
- Has
Linux boolWorkers Flag that displays whether an ASE has linux workers or not
- Id string
The provider-assigned unique ID for this managed resource.
- Maximum
Number intOf Machines Maximum number of VMs in the App Service Environment.
- Multi
Role intCount Number of front-end instances.
- Provisioning
State 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.
- dedicated
Host IntegerCount Dedicated Host Count
- has
Linux BooleanWorkers Flag that displays whether an ASE has linux workers or not
- id String
The provider-assigned unique ID for this managed resource.
- maximum
Number IntegerOf Machines Maximum number of VMs in the App Service Environment.
- multi
Role IntegerCount Number of front-end instances.
- provisioning
State 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 numberCount Dedicated Host Count
- has
Linux booleanWorkers Flag that displays whether an ASE has linux workers or not
- id string
The provider-assigned unique ID for this managed resource.
- maximum
Number numberOf Machines Maximum number of VMs in the App Service Environment.
- multi
Role numberCount Number of front-end instances.
- provisioning
State 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_ intcount Dedicated Host Count
- has_
linux_ boolworkers Flag that displays whether an ASE has linux workers or not
- id str
The provider-assigned unique ID for this managed resource.
- maximum_
number_ intof_ machines Maximum number of VMs in the App Service Environment.
- multi_
role_ intcount 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.
- dedicated
Host NumberCount Dedicated Host Count
- has
Linux BooleanWorkers Flag that displays whether an ASE has linux workers or not
- id String
The provider-assigned unique ID for this managed resource.
- maximum
Number NumberOf Machines Maximum number of VMs in the App Service Environment.
- multi
Role NumberCount Number of front-end instances.
- provisioning
State 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
- None
- None
- Web
- Web
- Publishing
- Publishing
- Web_Publishing
- Web, Publishing
- Load
Balancing Mode None - None
- Load
Balancing Mode Web - Web
- Load
Balancing Mode Publishing - Publishing
- Load
Balancing Mode_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
NameValuePairResponse
VirtualNetworkProfile
VirtualNetworkProfileResponse
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0