1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. getAppServiceEnvironment
Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

azure-native.web.getAppServiceEnvironment

Explore with Pulumi AI

azure-native logo
Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

    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.

    ResourceGroupName string

    Name of the resource group to which the resource belongs.

    Name string

    Name of the App Service Environment.

    ResourceGroupName string

    Name of the resource group to which the resource belongs.

    name String

    Name of the App Service Environment.

    resourceGroupName String

    Name of the resource group to which the resource belongs.

    name string

    Name of the App Service Environment.

    resourceGroupName string

    Name of the resource group to which the resource belongs.

    name str

    Name of the App Service Environment.

    resource_group_name str

    Name of the resource group to which the resource belongs.

    name String

    Name of the App Service Environment.

    resourceGroupName String

    Name of the resource group to which the resource belongs.

    getAppServiceEnvironment Result

    The following output properties are available:

    DedicatedHostCount int

    Dedicated Host Count

    HasLinuxWorkers bool

    Flag that displays whether an ASE has linux workers or not

    Id string

    Resource Id.

    Location string

    Resource Location.

    MaximumNumberOfMachines int

    Maximum number of VMs in the App Service Environment.

    MultiRoleCount int

    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.

    VirtualNetwork Pulumi.AzureNative.Web.Outputs.VirtualNetworkProfileResponse

    Description of the Virtual Network.

    ClusterSettings List<Pulumi.AzureNative.Web.Outputs.NameValuePairResponse>

    Custom settings for changing the behavior of the App Service Environment.

    DnsSuffix string

    DNS suffix of the App Service Environment.

    FrontEndScaleFactor int

    Scale factor for front-ends.

    InternalLoadBalancingMode string

    Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.

    IpsslAddressCount int

    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".

    Tags Dictionary<string, string>

    Resource tags.

    UserWhitelistedIpRanges List<string>

    User added list of IP Ranges allowed on ASE db

    DedicatedHostCount int

    Dedicated Host Count

    HasLinuxWorkers bool

    Flag that displays whether an ASE has linux workers or not

    Id string

    Resource Id.

    Location string

    Resource Location.

    MaximumNumberOfMachines int

    Maximum number of VMs in the App Service Environment.

    MultiRoleCount int

    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.

    VirtualNetwork VirtualNetworkProfileResponse

    Description of the Virtual Network.

    ClusterSettings []NameValuePairResponse

    Custom settings for changing the behavior of the App Service Environment.

    DnsSuffix string

    DNS suffix of the App Service Environment.

    FrontEndScaleFactor int

    Scale factor for front-ends.

    InternalLoadBalancingMode string

    Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.

    IpsslAddressCount int

    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".

    Tags map[string]string

    Resource tags.

    UserWhitelistedIpRanges []string

    User added list of IP Ranges allowed on ASE db

    dedicatedHostCount Integer

    Dedicated Host Count

    hasLinuxWorkers Boolean

    Flag that displays whether an ASE has linux workers or not

    id String

    Resource Id.

    location String

    Resource Location.

    maximumNumberOfMachines Integer

    Maximum number of VMs in the App Service Environment.

    multiRoleCount Integer

    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.

    virtualNetwork VirtualNetworkProfileResponse

    Description of the Virtual Network.

    clusterSettings List<NameValuePairResponse>

    Custom settings for changing the behavior of the App Service Environment.

    dnsSuffix String

    DNS suffix of the App Service Environment.

    frontEndScaleFactor Integer

    Scale factor for front-ends.

    internalLoadBalancingMode String

    Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.

    ipsslAddressCount Integer

    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".

    tags Map<String,String>

    Resource tags.

    userWhitelistedIpRanges List<String>

    User added list of IP Ranges allowed on ASE db

    dedicatedHostCount number

    Dedicated Host Count

    hasLinuxWorkers boolean

    Flag that displays whether an ASE has linux workers or not

    id string

    Resource Id.

    location string

    Resource Location.

    maximumNumberOfMachines number

    Maximum number of VMs in the App Service Environment.

    multiRoleCount number

    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.

    virtualNetwork VirtualNetworkProfileResponse

    Description of the Virtual Network.

    clusterSettings NameValuePairResponse[]

    Custom settings for changing the behavior of the App Service Environment.

    dnsSuffix string

    DNS suffix of the App Service Environment.

    frontEndScaleFactor number

    Scale factor for front-ends.

    internalLoadBalancingMode string

    Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.

    ipsslAddressCount number

    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".

    tags {[key: string]: string}

    Resource tags.

    userWhitelistedIpRanges string[]

    User added list of IP Ranges allowed on ASE db

    dedicated_host_count int

    Dedicated Host Count

    has_linux_workers bool

    Flag that displays whether an ASE has linux workers or not

    id str

    Resource Id.

    location str

    Resource Location.

    maximum_number_of_machines int

    Maximum number of VMs in the App Service Environment.

    multi_role_count int

    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 VirtualNetworkProfileResponse

    Description of the Virtual Network.

    cluster_settings Sequence[NameValuePairResponse]

    Custom settings for changing the behavior of the App Service Environment.

    dns_suffix str

    DNS suffix of the App Service Environment.

    front_end_scale_factor int

    Scale factor for front-ends.

    internal_load_balancing_mode str

    Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.

    ipssl_address_count int

    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".

    tags Mapping[str, str]

    Resource tags.

    user_whitelisted_ip_ranges Sequence[str]

    User added list of IP Ranges allowed on ASE db

    dedicatedHostCount Number

    Dedicated Host Count

    hasLinuxWorkers Boolean

    Flag that displays whether an ASE has linux workers or not

    id String

    Resource Id.

    location String

    Resource Location.

    maximumNumberOfMachines Number

    Maximum number of VMs in the App Service Environment.

    multiRoleCount Number

    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.

    virtualNetwork Property Map

    Description of the Virtual Network.

    clusterSettings List<Property Map>

    Custom settings for changing the behavior of the App Service Environment.

    dnsSuffix String

    DNS suffix of the App Service Environment.

    frontEndScaleFactor Number

    Scale factor for front-ends.

    internalLoadBalancingMode String

    Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.

    ipsslAddressCount Number

    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".

    tags Map<String>

    Resource tags.

    userWhitelistedIpRanges List<String>

    User added list of IP Ranges allowed on ASE db

    Supporting Types

    NameValuePairResponse

    Name string

    Pair name.

    Value string

    Pair value.

    Name string

    Pair name.

    Value string

    Pair value.

    name String

    Pair name.

    value String

    Pair value.

    name string

    Pair name.

    value string

    Pair value.

    name str

    Pair name.

    value str

    Pair value.

    name String

    Pair name.

    value String

    Pair value.

    VirtualNetworkProfileResponse

    Id string

    Resource id of the Virtual Network.

    Name string

    Name of the Virtual Network (read-only).

    Type string

    Resource type of the Virtual Network (read-only).

    Subnet string

    Subnet within the Virtual Network.

    Id string

    Resource id of the Virtual Network.

    Name string

    Name of the Virtual Network (read-only).

    Type string

    Resource type of the Virtual Network (read-only).

    Subnet string

    Subnet within the Virtual Network.

    id String

    Resource id of the Virtual Network.

    name String

    Name of the Virtual Network (read-only).

    type String

    Resource type of the Virtual Network (read-only).

    subnet String

    Subnet within the Virtual Network.

    id string

    Resource id of the Virtual Network.

    name string

    Name of the Virtual Network (read-only).

    type string

    Resource type of the Virtual Network (read-only).

    subnet string

    Subnet within the Virtual Network.

    id str

    Resource id of the Virtual Network.

    name str

    Name of the Virtual Network (read-only).

    type str

    Resource type of the Virtual Network (read-only).

    subnet str

    Subnet within the Virtual Network.

    id String

    Resource id of the Virtual Network.

    name String

    Name of the Virtual Network (read-only).

    type String

    Resource type of the Virtual Network (read-only).

    subnet String

    Subnet within the Virtual Network.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi