azure-native.web.AppServiceEnvironment
Explore with Pulumi AI
App Service Environment ARM resource.
Uses Azure REST API version 2024-04-01. In version 2.x of the Azure Native provider, it used API version 2022-09-01.
Other available API versions: 2016-09-01, 2018-02-01, 2019-08-01, 2020-06-01, 2020-09-01, 2020-10-01, 2020-12-01, 2021-01-01, 2021-01-15, 2021-02-01, 2021-03-01, 2022-03-01, 2022-09-01, 2023-01-01, 2023-12-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native web [ApiVersion]
. See the version guide for details.
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
This property is required. string - The unique name of the resource.
- args
This property is required. AppServiceEnvironmentArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. AppServiceEnvironmentArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. AppServiceEnvironmentArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. 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:
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of the resource group to which the resource belongs.
- Virtual
Network This property is required. Pulumi.Azure Native. Web. Inputs. Virtual Network Profile - Description of the Virtual Network.
- Cluster
Settings List<Pulumi.Azure Native. Web. Inputs. Name Value Pair> - Custom settings for changing the behavior of the App Service Environment.
- Custom
Dns Pulumi.Suffix Configuration Azure Native. Web. Inputs. Custom Dns Suffix Configuration - Full view of the custom domain suffix configuration for ASEv3.
- Dedicated
Host intCount - Dedicated Host Count
- 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. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
- Location string
- Resource Location.
- Multi
Size string - Front-end VM size, e.g. "Medium", "Large".
- Name
Changes to this property will trigger replacement.
- Name of the App Service Environment.
- Networking
Configuration Pulumi.Azure Native. Web. Inputs. Ase V3Networking Configuration - Full view of networking configuration for an ASE.
- Dictionary<string, string>
- Resource tags.
- Upgrade
Preference string | Pulumi.Azure Native. Web. Upgrade Preference - Upgrade Preference
- User
Whitelisted List<string>Ip Ranges - User added ip ranges to whitelist on ASE db
- Zone
Redundant bool - Whether or not this App Service Environment is zone-redundant.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of the resource group to which the resource belongs.
- Virtual
Network This property is required. VirtualNetwork Profile Args - Description of the Virtual Network.
- Cluster
Settings []NameValue Pair Args - Custom settings for changing the behavior of the App Service Environment.
- Custom
Dns CustomSuffix Configuration Dns Suffix Configuration Args - Full view of the custom domain suffix configuration for ASEv3.
- Dedicated
Host intCount - Dedicated Host Count
- 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. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
- Location string
- Resource Location.
- Multi
Size string - Front-end VM size, e.g. "Medium", "Large".
- Name
Changes to this property will trigger replacement.
- Name of the App Service Environment.
- Networking
Configuration AseV3Networking Configuration Args - Full view of networking configuration for an ASE.
- map[string]string
- Resource tags.
- Upgrade
Preference string | UpgradePreference - Upgrade Preference
- User
Whitelisted []stringIp Ranges - User added ip ranges to whitelist on ASE db
- Zone
Redundant bool - Whether or not this App Service Environment is zone-redundant.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of the resource group to which the resource belongs.
- virtual
Network This property is required. VirtualNetwork Profile - Description of the Virtual Network.
- cluster
Settings List<NameValue Pair> - Custom settings for changing the behavior of the App Service Environment.
- custom
Dns CustomSuffix Configuration Dns Suffix Configuration - Full view of the custom domain suffix configuration for ASEv3.
- dedicated
Host IntegerCount - Dedicated Host Count
- 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. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
- location String
- Resource Location.
- multi
Size String - Front-end VM size, e.g. "Medium", "Large".
- name
Changes to this property will trigger replacement.
- Name of the App Service Environment.
- networking
Configuration AseV3Networking Configuration - Full view of networking configuration for an ASE.
- Map<String,String>
- Resource tags.
- upgrade
Preference String | UpgradePreference - Upgrade Preference
- user
Whitelisted List<String>Ip Ranges - User added ip ranges to whitelist on ASE db
- zone
Redundant Boolean - Whether or not this App Service Environment is zone-redundant.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of the resource group to which the resource belongs.
- virtual
Network This property is required. VirtualNetwork Profile - Description of the Virtual Network.
- cluster
Settings NameValue Pair[] - Custom settings for changing the behavior of the App Service Environment.
- custom
Dns CustomSuffix Configuration Dns Suffix Configuration - Full view of the custom domain suffix configuration for ASEv3.
- dedicated
Host numberCount - Dedicated Host Count
- 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. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
- location string
- Resource Location.
- multi
Size string - Front-end VM size, e.g. "Medium", "Large".
- name
Changes to this property will trigger replacement.
- Name of the App Service Environment.
- networking
Configuration AseV3Networking Configuration - Full view of networking configuration for an ASE.
- {[key: string]: string}
- Resource tags.
- upgrade
Preference string | UpgradePreference - Upgrade Preference
- user
Whitelisted string[]Ip Ranges - User added ip ranges to whitelist on ASE db
- zone
Redundant boolean - Whether or not this App Service Environment is zone-redundant.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- Name of the resource group to which the resource belongs.
- virtual_
network This property is required. 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.
- custom_
dns_ Customsuffix_ configuration Dns Suffix Configuration Args - Full view of the custom domain suffix configuration for ASEv3.
- dedicated_
host_ intcount - Dedicated Host Count
- 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. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
- location str
- Resource Location.
- multi_
size str - Front-end VM size, e.g. "Medium", "Large".
- name
Changes to this property will trigger replacement.
- Name of the App Service Environment.
- networking_
configuration AseV3Networking Configuration Args - Full view of networking configuration for an ASE.
- Mapping[str, str]
- Resource tags.
- upgrade_
preference str | UpgradePreference - Upgrade Preference
- user_
whitelisted_ Sequence[str]ip_ ranges - User added ip ranges to whitelist on ASE db
- zone_
redundant bool - Whether or not this App Service Environment is zone-redundant.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of the resource group to which the resource belongs.
- virtual
Network This property is required. Property Map - Description of the Virtual Network.
- cluster
Settings List<Property Map> - Custom settings for changing the behavior of the App Service Environment.
- custom
Dns Property MapSuffix Configuration - Full view of the custom domain suffix configuration for ASEv3.
- dedicated
Host NumberCount - Dedicated Host Count
- 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. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
- location String
- Resource Location.
- multi
Size String - Front-end VM size, e.g. "Medium", "Large".
- name
Changes to this property will trigger replacement.
- Name of the App Service Environment.
- networking
Configuration Property Map - Full view of networking configuration for an ASE.
- Map<String>
- Resource tags.
- upgrade
Preference String | "None" | "Early" | "Late" | "Manual" - Upgrade Preference
- user
Whitelisted List<String>Ip Ranges - User added ip ranges to whitelist on ASE db
- zone
Redundant 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:
- Azure
Api stringVersion - The Azure API version of the resource.
- 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.
- Upgrade
Availability string - Whether an upgrade is available for this App Service Environment.
- Azure
Api stringVersion - The Azure API version of the resource.
- 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.
- Upgrade
Availability string - Whether an upgrade is available for this App Service Environment.
- azure
Api StringVersion - The Azure API version of the resource.
- 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.
- upgrade
Availability String - Whether an upgrade is available for this App Service Environment.
- azure
Api stringVersion - The Azure API version of the resource.
- 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.
- upgrade
Availability string - Whether an upgrade is available for this App Service Environment.
- azure_
api_ strversion - The Azure API version of the resource.
- 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.
- upgrade_
availability str - Whether an upgrade is available for this App Service Environment.
- azure
Api StringVersion - The Azure API version of the resource.
- 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.
- upgrade
Availability String - Whether an upgrade is available for this App Service Environment.
Supporting Types
AseV3NetworkingConfiguration, AseV3NetworkingConfigurationArgs
- Allow
New boolPrivate Endpoint Connections - 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 stringAddress Override - Customer provided Inbound IP Address. Only able to be set on Ase create.
- Kind string
- Kind of resource.
- Remote
Debug boolEnabled - Property to enable and disable Remote Debug on ASEV3
- Allow
New boolPrivate Endpoint Connections - 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 stringAddress Override - Customer provided Inbound IP Address. Only able to be set on Ase create.
- Kind string
- Kind of resource.
- Remote
Debug boolEnabled - Property to enable and disable Remote Debug on ASEV3
- allow
New BooleanPrivate Endpoint Connections - Property to enable and disable new private endpoint connection creation on ASE
- ftp
Enabled Boolean - Property to enable and disable FTP on ASEV3
- inbound
Ip StringAddress Override - Customer provided Inbound IP Address. Only able to be set on Ase create.
- kind String
- Kind of resource.
- remote
Debug BooleanEnabled - Property to enable and disable Remote Debug on ASEV3
- allow
New booleanPrivate Endpoint Connections - Property to enable and disable new private endpoint connection creation on ASE
- ftp
Enabled boolean - Property to enable and disable FTP on ASEV3
- inbound
Ip stringAddress Override - Customer provided Inbound IP Address. Only able to be set on Ase create.
- kind string
- Kind of resource.
- remote
Debug booleanEnabled - Property to enable and disable Remote Debug on ASEV3
- allow_
new_ boolprivate_ endpoint_ connections - 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_ straddress_ override - Customer provided Inbound IP Address. Only able to be set on Ase create.
- kind str
- Kind of resource.
- remote_
debug_ boolenabled - Property to enable and disable Remote Debug on ASEV3
- allow
New BooleanPrivate Endpoint Connections - Property to enable and disable new private endpoint connection creation on ASE
- ftp
Enabled Boolean - Property to enable and disable FTP on ASEV3
- inbound
Ip StringAddress Override - Customer provided Inbound IP Address. Only able to be set on Ase create.
- kind String
- Kind of resource.
- remote
Debug BooleanEnabled - Property to enable and disable Remote Debug on ASEV3
AseV3NetworkingConfigurationResponse, AseV3NetworkingConfigurationResponseArgs
- External
Inbound Ip Addresses This property is required. List<string> - Id
This property is required. string - Resource Id.
- Internal
Inbound Ip Addresses This property is required. List<string> - Linux
Outbound Ip Addresses This property is required. List<string> - Name
This property is required. string - Resource Name.
- Type
This property is required. string - Resource type.
- Windows
Outbound Ip Addresses This property is required. List<string> - Allow
New boolPrivate Endpoint Connections - 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 stringAddress Override - Customer provided Inbound IP Address. Only able to be set on Ase create.
- Kind string
- Kind of resource.
- Remote
Debug boolEnabled - Property to enable and disable Remote Debug on ASEV3
- External
Inbound Ip Addresses This property is required. []string - Id
This property is required. string - Resource Id.
- Internal
Inbound Ip Addresses This property is required. []string - Linux
Outbound Ip Addresses This property is required. []string - Name
This property is required. string - Resource Name.
- Type
This property is required. string - Resource type.
- Windows
Outbound Ip Addresses This property is required. []string - Allow
New boolPrivate Endpoint Connections - 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 stringAddress Override - Customer provided Inbound IP Address. Only able to be set on Ase create.
- Kind string
- Kind of resource.
- Remote
Debug boolEnabled - Property to enable and disable Remote Debug on ASEV3
- external
Inbound Ip Addresses This property is required. List<String> - id
This property is required. String - Resource Id.
- internal
Inbound Ip Addresses This property is required. List<String> - linux
Outbound Ip Addresses This property is required. List<String> - name
This property is required. String - Resource Name.
- type
This property is required. String - Resource type.
- windows
Outbound Ip Addresses This property is required. List<String> - allow
New BooleanPrivate Endpoint Connections - Property to enable and disable new private endpoint connection creation on ASE
- ftp
Enabled Boolean - Property to enable and disable FTP on ASEV3
- inbound
Ip StringAddress Override - Customer provided Inbound IP Address. Only able to be set on Ase create.
- kind String
- Kind of resource.
- remote
Debug BooleanEnabled - Property to enable and disable Remote Debug on ASEV3
- external
Inbound Ip Addresses This property is required. string[] - id
This property is required. string - Resource Id.
- internal
Inbound Ip Addresses This property is required. string[] - linux
Outbound Ip Addresses This property is required. string[] - name
This property is required. string - Resource Name.
- type
This property is required. string - Resource type.
- windows
Outbound Ip Addresses This property is required. string[] - allow
New booleanPrivate Endpoint Connections - Property to enable and disable new private endpoint connection creation on ASE
- ftp
Enabled boolean - Property to enable and disable FTP on ASEV3
- inbound
Ip stringAddress Override - Customer provided Inbound IP Address. Only able to be set on Ase create.
- kind string
- Kind of resource.
- remote
Debug booleanEnabled - Property to enable and disable Remote Debug on ASEV3
- external_
inbound_ ip_ addresses This property is required. Sequence[str] - id
This property is required. str - Resource Id.
- internal_
inbound_ ip_ addresses This property is required. Sequence[str] - linux_
outbound_ ip_ addresses This property is required. Sequence[str] - name
This property is required. str - Resource Name.
- type
This property is required. str - Resource type.
- windows_
outbound_ ip_ addresses This property is required. Sequence[str] - allow_
new_ boolprivate_ endpoint_ connections - 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_ straddress_ override - Customer provided Inbound IP Address. Only able to be set on Ase create.
- kind str
- Kind of resource.
- remote_
debug_ boolenabled - Property to enable and disable Remote Debug on ASEV3
- external
Inbound Ip Addresses This property is required. List<String> - id
This property is required. String - Resource Id.
- internal
Inbound Ip Addresses This property is required. List<String> - linux
Outbound Ip Addresses This property is required. List<String> - name
This property is required. String - Resource Name.
- type
This property is required. String - Resource type.
- windows
Outbound Ip Addresses This property is required. List<String> - allow
New BooleanPrivate Endpoint Connections - Property to enable and disable new private endpoint connection creation on ASE
- ftp
Enabled Boolean - Property to enable and disable FTP on ASEV3
- inbound
Ip StringAddress Override - Customer provided Inbound IP Address. Only able to be set on Ase create.
- kind String
- Kind of resource.
- remote
Debug BooleanEnabled - Property to enable and disable Remote Debug on ASEV3
CustomDnsSuffixConfiguration, CustomDnsSuffixConfigurationArgs
- Certificate
Url 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.
- Dns
Suffix string - The default custom domain suffix to use for all sites deployed on the ASE.
- Key
Vault stringReference Identity - 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 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.
- Dns
Suffix string - The default custom domain suffix to use for all sites deployed on the ASE.
- Key
Vault stringReference Identity - 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 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.
- dns
Suffix String - The default custom domain suffix to use for all sites deployed on the ASE.
- key
Vault StringReference Identity - 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 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.
- dns
Suffix string - The default custom domain suffix to use for all sites deployed on the ASE.
- key
Vault stringReference Identity - 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_ strreference_ identity - 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.
- certificate
Url 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.
- dns
Suffix String - The default custom domain suffix to use for all sites deployed on the ASE.
- key
Vault StringReference Identity - 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
This property is required. string - Resource Id.
- Name
This property is required. string - Resource Name.
- Provisioning
Details This property is required. string - Provisioning
State This property is required. string - Type
This property is required. string - Resource type.
- Certificate
Url 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.
- Dns
Suffix string - The default custom domain suffix to use for all sites deployed on the ASE.
- Key
Vault stringReference Identity - 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
This property is required. string - Resource Id.
- Name
This property is required. string - Resource Name.
- Provisioning
Details This property is required. string - Provisioning
State This property is required. string - Type
This property is required. string - Resource type.
- Certificate
Url 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.
- Dns
Suffix string - The default custom domain suffix to use for all sites deployed on the ASE.
- Key
Vault stringReference Identity - 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
This property is required. String - Resource Id.
- name
This property is required. String - Resource Name.
- provisioning
Details This property is required. String - provisioning
State This property is required. String - type
This property is required. String - Resource type.
- certificate
Url 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.
- dns
Suffix String - The default custom domain suffix to use for all sites deployed on the ASE.
- key
Vault StringReference Identity - 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
This property is required. string - Resource Id.
- name
This property is required. string - Resource Name.
- provisioning
Details This property is required. string - provisioning
State This property is required. string - type
This property is required. string - Resource type.
- certificate
Url 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.
- dns
Suffix string - The default custom domain suffix to use for all sites deployed on the ASE.
- key
Vault stringReference Identity - 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
This property is required. str - Resource Id.
- name
This property is required. str - Resource Name.
- provisioning_
details This property is required. str - provisioning_
state This property is required. str - type
This property is required. 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_ strreference_ identity - 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
This property is required. String - Resource Id.
- name
This property is required. String - Resource Name.
- provisioning
Details This property is required. String - provisioning
State This property is required. String - type
This property is required. String - Resource type.
- certificate
Url 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.
- dns
Suffix String - The default custom domain suffix to use for all sites deployed on the ASE.
- key
Vault StringReference Identity - 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
- 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, NameValuePairArgs
NameValuePairResponse, NameValuePairResponseArgs
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
- Upgrade
Preference None - NoneNo preference on when this App Service Environment will be upgraded
- Upgrade
Preference Early - EarlyThis App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late'
- Upgrade
Preference Late - LateThis App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early'
- Upgrade
Preference 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
- "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
VirtualNetworkProfileResponse, VirtualNetworkProfileResponseArgs
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