azure-native.web.getAppServiceEnvironment
Explore with Pulumi AI
Get the properties of an App Service Environment. API Version: 2020-12-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:
- Dedicated
Host intCount Dedicated Host Count
- 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.
- 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.
- 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".
- Dictionary<string, string>
Resource tags.
- User
Whitelisted List<string>Ip Ranges User added list of IP Ranges allowed on ASE db
- Dedicated
Host intCount Dedicated Host Count
- 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.
- 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.
- 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".
- map[string]string
Resource tags.
- User
Whitelisted []stringIp Ranges User added list of IP Ranges allowed on ASE db
- dedicated
Host IntegerCount Dedicated Host Count
- 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.
- 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.
- 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".
- Map<String,String>
Resource tags.
- user
Whitelisted List<String>Ip Ranges User added list of IP Ranges allowed on ASE db
- dedicated
Host numberCount Dedicated Host Count
- 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.
- 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.
- 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".
- {[key: string]: string}
Resource tags.
- user
Whitelisted string[]Ip Ranges User added list of IP Ranges allowed on ASE db
- dedicated_
host_ intcount Dedicated Host Count
- 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.
- 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.
- 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".
- Mapping[str, str]
Resource tags.
- user_
whitelisted_ Sequence[str]ip_ ranges User added list of IP Ranges allowed on ASE db
- dedicated
Host NumberCount Dedicated Host Count
- 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.
- virtual
Network Property Map Description of the Virtual Network.
- cluster
Settings List<Property Map> Custom settings for changing the behavior of the App Service Environment.
- dns
Suffix String DNS suffix of the App Service Environment.
- front
End NumberScale Factor Scale factor for front-ends.
- internal
Load 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".
- Map<String>
Resource tags.
- user
Whitelisted List<String>Ip Ranges User added list of IP Ranges allowed on ASE db
Supporting Types
NameValuePairResponse
VirtualNetworkProfileResponse
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0