This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
azure-native.web.getAppServiceEnvironment
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
Description for Get the properties of an App Service Environment. 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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:web:getAppServiceEnvironment
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
- Name of the App Service Environment.
- Resource
Group stringName - Name of the resource group to which the resource belongs.
- Name string
- Name of the App Service Environment.
- Resource
Group stringName - Name of the resource group to which the resource belongs.
- name String
- Name of the App Service Environment.
- resource
Group StringName - Name of the resource group to which the resource belongs.
- name string
- Name of the App Service Environment.
- resource
Group 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.
- resource
Group StringName - Name of the resource group to which the resource belongs.
getAppServiceEnvironment Result
The following output properties are available:
- Has
Linux boolWorkers - Flag that displays whether an ASE has linux workers or not
- Id string
- Resource Id.
- Location string
- Resource Location.
- Maximum
Number intOf Machines - Maximum number of VMs in the App Service Environment.
- Multi
Role intCount - Number of front-end instances.
- Name string
- Resource Name.
- 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.
- Virtual
Network Pulumi.Azure Native. Web. Outputs. Virtual Network Profile Response - Description of the Virtual Network.
- Cluster
Settings List<Pulumi.Azure Native. Web. Outputs. Name Value Pair Response> - Custom settings for changing the behavior of the App Service Environment.
- Custom
Dns Pulumi.Suffix Configuration Azure Native. Web. Outputs. Custom Dns Suffix Configuration Response - 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 stringBalancing 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.
- Multi
Size string - Front-end VM size, e.g. "Medium", "Large".
- Networking
Configuration Pulumi.Azure Native. Web. Outputs. Ase V3Networking Configuration Response - Full view of networking configuration for an ASE.
- Dictionary<string, string>
- Resource tags.
- Upgrade
Preference string - 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.
- Has
Linux boolWorkers - Flag that displays whether an ASE has linux workers or not
- Id string
- Resource Id.
- Location string
- Resource Location.
- Maximum
Number intOf Machines - Maximum number of VMs in the App Service Environment.
- Multi
Role intCount - Number of front-end instances.
- Name string
- Resource Name.
- 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.
- Virtual
Network VirtualNetwork Profile Response - Description of the Virtual Network.
- Cluster
Settings []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 string - DNS suffix of the App Service Environment.
- Front
End intScale Factor - Scale factor for front-ends.
- Internal
Load stringBalancing 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.
- Multi
Size string - Front-end VM size, e.g. "Medium", "Large".
- Networking
Configuration AseV3Networking Configuration Response - Full view of networking configuration for an ASE.
- map[string]string
- Resource tags.
- Upgrade
Preference string - 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.
- has
Linux BooleanWorkers - Flag that displays whether an ASE has linux workers or not
- id String
- Resource Id.
- location String
- Resource Location.
- maximum
Number IntegerOf Machines - Maximum number of VMs in the App Service Environment.
- multi
Role IntegerCount - Number of front-end instances.
- name String
- Resource Name.
- 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.
- virtual
Network VirtualNetwork Profile Response - Description of the Virtual Network.
- cluster
Settings List<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 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 StringBalancing 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.
- multi
Size String - Front-end VM size, e.g. "Medium", "Large".
- networking
Configuration AseV3Networking Configuration Response - Full view of networking configuration for an ASE.
- Map<String,String>
- Resource tags.
- upgrade
Preference String - 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.
- has
Linux booleanWorkers - Flag that displays whether an ASE has linux workers or not
- id string
- Resource Id.
- location string
- Resource Location.
- maximum
Number numberOf Machines - Maximum number of VMs in the App Service Environment.
- multi
Role numberCount - Number of front-end instances.
- name string
- Resource Name.
- 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.
- virtual
Network VirtualNetwork Profile Response - Description of the Virtual Network.
- cluster
Settings 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 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 stringBalancing 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.
- multi
Size string - Front-end VM size, e.g. "Medium", "Large".
- networking
Configuration AseV3Networking Configuration Response - Full view of networking configuration for an ASE.
- {[key: string]: string}
- Resource tags.
- upgrade
Preference string - 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.
- 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.
- has
Linux BooleanWorkers - Flag that displays whether an ASE has linux workers or not
- id String
- Resource Id.
- location String
- Resource Location.
- maximum
Number NumberOf Machines - Maximum number of VMs in the App Service Environment.
- multi
Role NumberCount - Number of front-end instances.
- name String
- Resource Name.
- 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.
- 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.
- 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 StringBalancing 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.
- multi
Size String - Front-end VM size, e.g. "Medium", "Large".
- networking
Configuration Property Map - Full view of networking configuration for an ASE.
- Map<String>
- Resource tags.
- upgrade
Preference String - 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.
Supporting Types
AseV3NetworkingConfigurationResponse
- External
Inbound List<string>Ip Addresses - Id string
- Resource Id.
- Internal
Inbound List<string>Ip Addresses - Linux
Outbound List<string>Ip Addresses - Name string
- Resource Name.
- Type string
- Resource type.
- Windows
Outbound List<string>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 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 []stringIp Addresses - Id string
- Resource Id.
- Internal
Inbound []stringIp Addresses - Linux
Outbound []stringIp Addresses - Name string
- Resource Name.
- Type string
- Resource type.
- Windows
Outbound []stringIp 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 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 List<String>Ip Addresses - id String
- Resource Id.
- internal
Inbound List<String>Ip Addresses - linux
Outbound List<String>Ip Addresses - name String
- Resource Name.
- type String
- Resource type.
- windows
Outbound List<String>Ip Addresses - 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 string[]Ip Addresses - id string
- Resource Id.
- internal
Inbound string[]Ip Addresses - linux
Outbound string[]Ip Addresses - name string
- Resource Name.
- type string
- Resource type.
- windows
Outbound string[]Ip Addresses - 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_ 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
- external
Inbound List<String>Ip Addresses - id String
- Resource Id.
- internal
Inbound List<String>Ip Addresses - linux
Outbound List<String>Ip Addresses - name String
- Resource Name.
- type String
- Resource type.
- windows
Outbound List<String>Ip Addresses - 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
CustomDnsSuffixConfigurationResponse
- Id string
- Resource Id.
- Name string
- Resource Name.
- Provisioning
Details string - Provisioning
State string - Type 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 string
- Resource Id.
- Name string
- Resource Name.
- Provisioning
Details string - Provisioning
State string - Type 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 String
- Resource Id.
- name String
- Resource Name.
- provisioning
Details String - provisioning
State String - type 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 string
- Resource Id.
- name string
- Resource Name.
- provisioning
Details string - provisioning
State string - type 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 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.
- provisioning
Details String - provisioning
State String - type 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.
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 v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi