This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
azure-native.web.getAppServiceEnvironment
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
Description for Get the properties of an App Service Environment.
Uses Azure REST API version 2022-09-01.
Other available API versions: 2019-08-01, 2020-10-01, 2021-01-15, 2023-01-01, 2023-12-01, 2024-04-01.
Using getAppServiceEnvironment
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getAppServiceEnvironment(args: GetAppServiceEnvironmentArgs, opts?: InvokeOptions): Promise<GetAppServiceEnvironmentResult>
function getAppServiceEnvironmentOutput(args: GetAppServiceEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetAppServiceEnvironmentResult>def get_app_service_environment(name: Optional[str] = None,
                                resource_group_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetAppServiceEnvironmentResult
def get_app_service_environment_output(name: Optional[pulumi.Input[str]] = None,
                                resource_group_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetAppServiceEnvironmentResult]func LookupAppServiceEnvironment(ctx *Context, args *LookupAppServiceEnvironmentArgs, opts ...InvokeOption) (*LookupAppServiceEnvironmentResult, error)
func LookupAppServiceEnvironmentOutput(ctx *Context, args *LookupAppServiceEnvironmentOutputArgs, opts ...InvokeOption) LookupAppServiceEnvironmentResultOutput> Note: This function is named LookupAppServiceEnvironment in the Go SDK.
public static class GetAppServiceEnvironment 
{
    public static Task<GetAppServiceEnvironmentResult> InvokeAsync(GetAppServiceEnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetAppServiceEnvironmentResult> Invoke(GetAppServiceEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetAppServiceEnvironmentResult> getAppServiceEnvironment(GetAppServiceEnvironmentArgs args, InvokeOptions options)
public static Output<GetAppServiceEnvironmentResult> getAppServiceEnvironment(GetAppServiceEnvironmentArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:web:getAppServiceEnvironment
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Name string
- Name of the App Service Environment.
- ResourceGroup stringName 
- Name of the resource group to which the resource belongs.
- Name string
- Name of the App Service Environment.
- ResourceGroup stringName 
- Name of the resource group to which the resource belongs.
- name String
- Name of the App Service Environment.
- resourceGroup StringName 
- Name of the resource group to which the resource belongs.
- name string
- Name of the App Service Environment.
- resourceGroup stringName 
- Name of the resource group to which the resource belongs.
- name str
- Name of the App Service Environment.
- resource_group_ strname 
- Name of the resource group to which the resource belongs.
- name String
- Name of the App Service Environment.
- resourceGroup StringName 
- Name of the resource group to which the resource belongs.
getAppServiceEnvironment Result
The following output properties are available:
- HasLinux boolWorkers 
- Flag that displays whether an ASE has linux workers or not
- Id string
- Resource Id.
- Location string
- Resource Location.
- MaximumNumber intOf Machines 
- Maximum number of VMs in the App Service Environment.
- MultiRole intCount 
- Number of front-end instances.
- Name string
- Resource Name.
- ProvisioningState string
- Provisioning state of the App Service Environment.
- Status string
- Current status of the App Service Environment.
- Suspended bool
- true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
- Type string
- Resource type.
- UpgradeAvailability string
- Whether an upgrade is available for this App Service Environment.
- VirtualNetwork Pulumi.Azure Native. Web. Outputs. Virtual Network Profile Response 
- Description of the Virtual Network.
- ClusterSettings List<Pulumi.Azure Native. Web. Outputs. Name Value Pair Response> 
- Custom settings for changing the behavior of the App Service Environment.
- CustomDns Pulumi.Suffix Configuration Azure Native. Web. Outputs. Custom Dns Suffix Configuration Response 
- Full view of the custom domain suffix configuration for ASEv3.
- DedicatedHost intCount 
- Dedicated Host Count
- DnsSuffix string
- DNS suffix of the App Service Environment.
- FrontEnd intScale Factor 
- Scale factor for front-ends.
- InternalLoad stringBalancing Mode 
- Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
- IpsslAddress intCount 
- Number of IP SSL addresses reserved for the App Service Environment.
- Kind string
- Kind of resource.
- MultiSize string
- Front-end VM size, e.g. "Medium", "Large".
- NetworkingConfiguration Pulumi.Azure Native. Web. Outputs. Ase V3Networking Configuration Response 
- Full view of networking configuration for an ASE.
- Dictionary<string, string>
- Resource tags.
- UpgradePreference string
- Upgrade Preference
- UserWhitelisted List<string>Ip Ranges 
- User added ip ranges to whitelist on ASE db
- ZoneRedundant bool
- Whether or not this App Service Environment is zone-redundant.
- HasLinux boolWorkers 
- Flag that displays whether an ASE has linux workers or not
- Id string
- Resource Id.
- Location string
- Resource Location.
- MaximumNumber intOf Machines 
- Maximum number of VMs in the App Service Environment.
- MultiRole intCount 
- Number of front-end instances.
- Name string
- Resource Name.
- ProvisioningState string
- Provisioning state of the App Service Environment.
- Status string
- Current status of the App Service Environment.
- Suspended bool
- true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
- Type string
- Resource type.
- UpgradeAvailability string
- Whether an upgrade is available for this App Service Environment.
- VirtualNetwork VirtualNetwork Profile Response 
- Description of the Virtual Network.
- ClusterSettings []NameValue Pair Response 
- Custom settings for changing the behavior of the App Service Environment.
- CustomDns CustomSuffix Configuration Dns Suffix Configuration Response 
- Full view of the custom domain suffix configuration for ASEv3.
- DedicatedHost intCount 
- Dedicated Host Count
- DnsSuffix string
- DNS suffix of the App Service Environment.
- FrontEnd intScale Factor 
- Scale factor for front-ends.
- InternalLoad stringBalancing Mode 
- Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
- IpsslAddress intCount 
- Number of IP SSL addresses reserved for the App Service Environment.
- Kind string
- Kind of resource.
- MultiSize string
- Front-end VM size, e.g. "Medium", "Large".
- NetworkingConfiguration AseV3Networking Configuration Response 
- Full view of networking configuration for an ASE.
- map[string]string
- Resource tags.
- UpgradePreference string
- Upgrade Preference
- UserWhitelisted []stringIp Ranges 
- User added ip ranges to whitelist on ASE db
- ZoneRedundant bool
- Whether or not this App Service Environment is zone-redundant.
- hasLinux BooleanWorkers 
- Flag that displays whether an ASE has linux workers or not
- id String
- Resource Id.
- location String
- Resource Location.
- maximumNumber IntegerOf Machines 
- Maximum number of VMs in the App Service Environment.
- multiRole IntegerCount 
- Number of front-end instances.
- name String
- Resource Name.
- provisioningState String
- Provisioning state of the App Service Environment.
- status String
- Current status of the App Service Environment.
- suspended Boolean
- true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
- type String
- Resource type.
- upgradeAvailability String
- Whether an upgrade is available for this App Service Environment.
- virtualNetwork VirtualNetwork Profile Response 
- Description of the Virtual Network.
- clusterSettings List<NameValue Pair Response> 
- Custom settings for changing the behavior of the App Service Environment.
- customDns CustomSuffix Configuration Dns Suffix Configuration Response 
- Full view of the custom domain suffix configuration for ASEv3.
- dedicatedHost IntegerCount 
- Dedicated Host Count
- dnsSuffix String
- DNS suffix of the App Service Environment.
- frontEnd IntegerScale Factor 
- Scale factor for front-ends.
- internalLoad StringBalancing Mode 
- Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
- ipsslAddress IntegerCount 
- Number of IP SSL addresses reserved for the App Service Environment.
- kind String
- Kind of resource.
- multiSize String
- Front-end VM size, e.g. "Medium", "Large".
- networkingConfiguration AseV3Networking Configuration Response 
- Full view of networking configuration for an ASE.
- Map<String,String>
- Resource tags.
- upgradePreference String
- Upgrade Preference
- userWhitelisted List<String>Ip Ranges 
- User added ip ranges to whitelist on ASE db
- zoneRedundant Boolean
- Whether or not this App Service Environment is zone-redundant.
- hasLinux booleanWorkers 
- Flag that displays whether an ASE has linux workers or not
- id string
- Resource Id.
- location string
- Resource Location.
- maximumNumber numberOf Machines 
- Maximum number of VMs in the App Service Environment.
- multiRole numberCount 
- Number of front-end instances.
- name string
- Resource Name.
- provisioningState string
- Provisioning state of the App Service Environment.
- status string
- Current status of the App Service Environment.
- suspended boolean
- true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
- type string
- Resource type.
- upgradeAvailability string
- Whether an upgrade is available for this App Service Environment.
- virtualNetwork VirtualNetwork Profile Response 
- Description of the Virtual Network.
- clusterSettings NameValue Pair Response[] 
- Custom settings for changing the behavior of the App Service Environment.
- customDns CustomSuffix Configuration Dns Suffix Configuration Response 
- Full view of the custom domain suffix configuration for ASEv3.
- dedicatedHost numberCount 
- Dedicated Host Count
- dnsSuffix string
- DNS suffix of the App Service Environment.
- frontEnd numberScale Factor 
- Scale factor for front-ends.
- internalLoad stringBalancing Mode 
- Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
- ipsslAddress numberCount 
- Number of IP SSL addresses reserved for the App Service Environment.
- kind string
- Kind of resource.
- multiSize string
- Front-end VM size, e.g. "Medium", "Large".
- networkingConfiguration AseV3Networking Configuration Response 
- Full view of networking configuration for an ASE.
- {[key: string]: string}
- Resource tags.
- upgradePreference string
- Upgrade Preference
- userWhitelisted string[]Ip Ranges 
- User added ip ranges to whitelist on ASE db
- zoneRedundant boolean
- Whether or not this App Service Environment is zone-redundant.
- has_linux_ boolworkers 
- Flag that displays whether an ASE has linux workers or not
- id str
- Resource Id.
- location str
- Resource Location.
- maximum_number_ intof_ machines 
- Maximum number of VMs in the App Service Environment.
- multi_role_ intcount 
- Number of front-end instances.
- name str
- Resource Name.
- 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.
- virtual_network VirtualNetwork Profile Response 
- Description of the Virtual Network.
- cluster_settings Sequence[NameValue Pair Response] 
- Custom settings for changing the behavior of the App Service Environment.
- custom_dns_ Customsuffix_ configuration Dns Suffix Configuration Response 
- 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_ strbalancing_ 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.
- multi_size str
- Front-end VM size, e.g. "Medium", "Large".
- networking_configuration AseV3Networking Configuration Response 
- Full view of networking configuration for an ASE.
- Mapping[str, str]
- Resource tags.
- upgrade_preference str
- 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.
- hasLinux BooleanWorkers 
- Flag that displays whether an ASE has linux workers or not
- id String
- Resource Id.
- location String
- Resource Location.
- maximumNumber NumberOf Machines 
- Maximum number of VMs in the App Service Environment.
- multiRole NumberCount 
- Number of front-end instances.
- name String
- Resource Name.
- provisioningState String
- Provisioning state of the App Service Environment.
- status String
- Current status of the App Service Environment.
- suspended Boolean
- true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
- type String
- Resource type.
- upgradeAvailability String
- Whether an upgrade is available for this App Service Environment.
- virtualNetwork Property Map
- Description of the Virtual Network.
- clusterSettings List<Property Map>
- Custom settings for changing the behavior of the App Service Environment.
- customDns Property MapSuffix Configuration 
- Full view of the custom domain suffix configuration for ASEv3.
- dedicatedHost NumberCount 
- Dedicated Host Count
- dnsSuffix String
- DNS suffix of the App Service Environment.
- frontEnd NumberScale Factor 
- Scale factor for front-ends.
- internalLoad StringBalancing Mode 
- Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
- ipsslAddress NumberCount 
- Number of IP SSL addresses reserved for the App Service Environment.
- kind String
- Kind of resource.
- multiSize String
- Front-end VM size, e.g. "Medium", "Large".
- networkingConfiguration Property Map
- Full view of networking configuration for an ASE.
- Map<String>
- Resource tags.
- upgradePreference String
- Upgrade Preference
- userWhitelisted List<String>Ip Ranges 
- User added ip ranges to whitelist on ASE db
- zoneRedundant Boolean
- Whether or not this App Service Environment is zone-redundant.
Supporting Types
AseV3NetworkingConfigurationResponse   
- ExternalInbound List<string>Ip Addresses 
- Id string
- Resource Id.
- InternalInbound List<string>Ip Addresses 
- LinuxOutbound List<string>Ip Addresses 
- Name string
- Resource Name.
- Type string
- Resource type.
- WindowsOutbound List<string>Ip Addresses 
- AllowNew boolPrivate Endpoint Connections 
- Property to enable and disable new private endpoint connection creation on ASE
- FtpEnabled bool
- Property to enable and disable FTP on ASEV3
- InboundIp stringAddress Override 
- Customer provided Inbound IP Address. Only able to be set on Ase create.
- Kind string
- Kind of resource.
- RemoteDebug boolEnabled 
- Property to enable and disable Remote Debug on ASEV3
- ExternalInbound []stringIp Addresses 
- Id string
- Resource Id.
- InternalInbound []stringIp Addresses 
- LinuxOutbound []stringIp Addresses 
- Name string
- Resource Name.
- Type string
- Resource type.
- WindowsOutbound []stringIp Addresses 
- AllowNew boolPrivate Endpoint Connections 
- Property to enable and disable new private endpoint connection creation on ASE
- FtpEnabled bool
- Property to enable and disable FTP on ASEV3
- InboundIp stringAddress Override 
- Customer provided Inbound IP Address. Only able to be set on Ase create.
- Kind string
- Kind of resource.
- RemoteDebug boolEnabled 
- Property to enable and disable Remote Debug on ASEV3
- externalInbound List<String>Ip Addresses 
- id String
- Resource Id.
- internalInbound List<String>Ip Addresses 
- linuxOutbound List<String>Ip Addresses 
- name String
- Resource Name.
- type String
- Resource type.
- windowsOutbound List<String>Ip Addresses 
- allowNew BooleanPrivate Endpoint Connections 
- Property to enable and disable new private endpoint connection creation on ASE
- ftpEnabled Boolean
- Property to enable and disable FTP on ASEV3
- inboundIp StringAddress Override 
- Customer provided Inbound IP Address. Only able to be set on Ase create.
- kind String
- Kind of resource.
- remoteDebug BooleanEnabled 
- Property to enable and disable Remote Debug on ASEV3
- externalInbound string[]Ip Addresses 
- id string
- Resource Id.
- internalInbound string[]Ip Addresses 
- linuxOutbound string[]Ip Addresses 
- name string
- Resource Name.
- type string
- Resource type.
- windowsOutbound string[]Ip Addresses 
- allowNew booleanPrivate Endpoint Connections 
- Property to enable and disable new private endpoint connection creation on ASE
- ftpEnabled boolean
- Property to enable and disable FTP on ASEV3
- inboundIp stringAddress Override 
- Customer provided Inbound IP Address. Only able to be set on Ase create.
- kind string
- Kind of resource.
- remoteDebug booleanEnabled 
- Property to enable and disable Remote Debug on ASEV3
- external_inbound_ Sequence[str]ip_ addresses 
- id str
- Resource Id.
- internal_inbound_ Sequence[str]ip_ addresses 
- linux_outbound_ Sequence[str]ip_ addresses 
- name str
- Resource Name.
- type str
- Resource type.
- windows_outbound_ Sequence[str]ip_ addresses 
- 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
- externalInbound List<String>Ip Addresses 
- id String
- Resource Id.
- internalInbound List<String>Ip Addresses 
- linuxOutbound List<String>Ip Addresses 
- name String
- Resource Name.
- type String
- Resource type.
- windowsOutbound List<String>Ip Addresses 
- allowNew BooleanPrivate Endpoint Connections 
- Property to enable and disable new private endpoint connection creation on ASE
- ftpEnabled Boolean
- Property to enable and disable FTP on ASEV3
- inboundIp StringAddress Override 
- Customer provided Inbound IP Address. Only able to be set on Ase create.
- kind String
- Kind of resource.
- remoteDebug BooleanEnabled 
- Property to enable and disable Remote Debug on ASEV3
CustomDnsSuffixConfigurationResponse    
- Id string
- Resource Id.
- Name string
- Resource Name.
- ProvisioningDetails string
- ProvisioningState string
- Type string
- Resource type.
- CertificateUrl string
- The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
- DnsSuffix string
- The default custom domain suffix to use for all sites deployed on the ASE.
- KeyVault 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 string
- Resource Id.
- Name string
- Resource Name.
- ProvisioningDetails string
- ProvisioningState string
- Type string
- Resource type.
- CertificateUrl string
- The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
- DnsSuffix string
- The default custom domain suffix to use for all sites deployed on the ASE.
- KeyVault 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 String
- Resource Id.
- name String
- Resource Name.
- provisioningDetails String
- provisioningState String
- type String
- Resource type.
- certificateUrl String
- The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
- dnsSuffix String
- The default custom domain suffix to use for all sites deployed on the ASE.
- keyVault 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 string
- Resource Id.
- name string
- Resource Name.
- provisioningDetails string
- provisioningState string
- type string
- Resource type.
- certificateUrl string
- The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
- dnsSuffix string
- The default custom domain suffix to use for all sites deployed on the ASE.
- keyVault 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 str
- Resource Id.
- name str
- Resource Name.
- provisioning_details str
- provisioning_state str
- type str
- Resource type.
- certificate_url str
- The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
- dns_suffix str
- The default custom domain suffix to use for all sites deployed on the ASE.
- key_vault_ 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 String
- Resource Id.
- name String
- Resource Name.
- provisioningDetails String
- provisioningState String
- type String
- Resource type.
- certificateUrl String
- The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
- dnsSuffix String
- The default custom domain suffix to use for all sites deployed on the ASE.
- keyVault 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.
NameValuePairResponse   
VirtualNetworkProfileResponse   
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi