1. Packages
  2. Packages
  3. Azure Classic
  4. API Docs
  5. appservice
  6. getAppServiceEnvironment

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    Use this data source to access information about an existing App Service Environment.

    Example Usage

    using Pulumi;
    using Azure = Pulumi.Azure;
    
    class MyStack : Stack
    {
        public MyStack()
        {
            var example = Output.Create(Azure.AppService.GetAppServiceEnvironment.InvokeAsync(new Azure.AppService.GetAppServiceEnvironmentArgs
            {
                Name = "existing-ase",
                ResourceGroupName = "existing-rg",
            }));
            this.Id = example.Apply(example => example.Id);
        }
    
        [Output("id")]
        public Output<string> Id { get; set; }
    }
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/appservice"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := appservice.GetAppServiceEnvironment(ctx, &appservice.GetAppServiceEnvironmentArgs{
    			Name:              "existing-ase",
    			ResourceGroupName: "existing-rg",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("id", example.Id)
    		return nil
    	})
    }
    

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = azure.appservice.getAppServiceEnvironment({
        name: "existing-ase",
        resourceGroupName: "existing-rg",
    });
    export const id = example.then(example => example.id);
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.appservice.get_app_service_environment(name="existing-ase",
        resource_group_name="existing-rg")
    pulumi.export("id", example.id)
    

    Example coming soon!

    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 GetAppServiceEnvironment(ctx *Context, args *GetAppServiceEnvironmentArgs, opts ...InvokeOption) (*GetAppServiceEnvironmentResult, error)
    func GetAppServiceEnvironmentOutput(ctx *Context, args *GetAppServiceEnvironmentOutputArgs, opts ...InvokeOption) GetAppServiceEnvironmentResultOutput

    > Note: This function is named GetAppServiceEnvironment 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:appservice/getAppServiceEnvironment:getAppServiceEnvironment
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of this App Service Environment.
    ResourceGroupName string
    The name of the Resource Group where the App Service Environment exists.
    Name string
    The name of this App Service Environment.
    ResourceGroupName string
    The name of the Resource Group where the App Service Environment exists.
    name String
    The name of this App Service Environment.
    resourceGroupName String
    The name of the Resource Group where the App Service Environment exists.
    name string
    The name of this App Service Environment.
    resourceGroupName string
    The name of the Resource Group where the App Service Environment exists.
    name str
    The name of this App Service Environment.
    resource_group_name str
    The name of the Resource Group where the App Service Environment exists.
    name String
    The name of this App Service Environment.
    resourceGroupName String
    The name of the Resource Group where the App Service Environment exists.

    getAppServiceEnvironment Result

    The following output properties are available:

    ClusterSettings List<GetAppServiceEnvironmentClusterSetting>
    Zero or more cluster_setting blocks as defined below.
    FrontEndScaleFactor int
    The number of app instances per App Service Environment Front End.
    Id string
    The provider-assigned unique ID for this managed resource.
    InternalIpAddress string
    IP address of internal load balancer of the App Service Environment.
    Location string
    The Azure Region where the App Service Environment exists.
    Name string
    The name of the Cluster Setting.
    OutboundIpAddresses List<string>
    List of outbound IP addresses of the App Service Environment.
    PricingTier string
    The Pricing Tier (Isolated SKU) of the App Service Environment.
    ResourceGroupName string
    ServiceIpAddress string
    IP address of service endpoint of the App Service Environment.
    Tags Dictionary<string, string>
    A mapping of tags assigned to the App Service Environment.
    ClusterSettings []GetAppServiceEnvironmentClusterSetting
    Zero or more cluster_setting blocks as defined below.
    FrontEndScaleFactor int
    The number of app instances per App Service Environment Front End.
    Id string
    The provider-assigned unique ID for this managed resource.
    InternalIpAddress string
    IP address of internal load balancer of the App Service Environment.
    Location string
    The Azure Region where the App Service Environment exists.
    Name string
    The name of the Cluster Setting.
    OutboundIpAddresses []string
    List of outbound IP addresses of the App Service Environment.
    PricingTier string
    The Pricing Tier (Isolated SKU) of the App Service Environment.
    ResourceGroupName string
    ServiceIpAddress string
    IP address of service endpoint of the App Service Environment.
    Tags map[string]string
    A mapping of tags assigned to the App Service Environment.
    clusterSettings List<GetAppServiceEnvironmentClusterSetting>
    Zero or more cluster_setting blocks as defined below.
    frontEndScaleFactor Integer
    The number of app instances per App Service Environment Front End.
    id String
    The provider-assigned unique ID for this managed resource.
    internalIpAddress String
    IP address of internal load balancer of the App Service Environment.
    location String
    The Azure Region where the App Service Environment exists.
    name String
    The name of the Cluster Setting.
    outboundIpAddresses List<String>
    List of outbound IP addresses of the App Service Environment.
    pricingTier String
    The Pricing Tier (Isolated SKU) of the App Service Environment.
    resourceGroupName String
    serviceIpAddress String
    IP address of service endpoint of the App Service Environment.
    tags Map<String,String>
    A mapping of tags assigned to the App Service Environment.
    clusterSettings GetAppServiceEnvironmentClusterSetting[]
    Zero or more cluster_setting blocks as defined below.
    frontEndScaleFactor number
    The number of app instances per App Service Environment Front End.
    id string
    The provider-assigned unique ID for this managed resource.
    internalIpAddress string
    IP address of internal load balancer of the App Service Environment.
    location string
    The Azure Region where the App Service Environment exists.
    name string
    The name of the Cluster Setting.
    outboundIpAddresses string[]
    List of outbound IP addresses of the App Service Environment.
    pricingTier string
    The Pricing Tier (Isolated SKU) of the App Service Environment.
    resourceGroupName string
    serviceIpAddress string
    IP address of service endpoint of the App Service Environment.
    tags {[key: string]: string}
    A mapping of tags assigned to the App Service Environment.
    cluster_settings Sequence[GetAppServiceEnvironmentClusterSetting]
    Zero or more cluster_setting blocks as defined below.
    front_end_scale_factor int
    The number of app instances per App Service Environment Front End.
    id str
    The provider-assigned unique ID for this managed resource.
    internal_ip_address str
    IP address of internal load balancer of the App Service Environment.
    location str
    The Azure Region where the App Service Environment exists.
    name str
    The name of the Cluster Setting.
    outbound_ip_addresses Sequence[str]
    List of outbound IP addresses of the App Service Environment.
    pricing_tier str
    The Pricing Tier (Isolated SKU) of the App Service Environment.
    resource_group_name str
    service_ip_address str
    IP address of service endpoint of the App Service Environment.
    tags Mapping[str, str]
    A mapping of tags assigned to the App Service Environment.
    clusterSettings List<Property Map>
    Zero or more cluster_setting blocks as defined below.
    frontEndScaleFactor Number
    The number of app instances per App Service Environment Front End.
    id String
    The provider-assigned unique ID for this managed resource.
    internalIpAddress String
    IP address of internal load balancer of the App Service Environment.
    location String
    The Azure Region where the App Service Environment exists.
    name String
    The name of the Cluster Setting.
    outboundIpAddresses List<String>
    List of outbound IP addresses of the App Service Environment.
    pricingTier String
    The Pricing Tier (Isolated SKU) of the App Service Environment.
    resourceGroupName String
    serviceIpAddress String
    IP address of service endpoint of the App Service Environment.
    tags Map<String>
    A mapping of tags assigned to the App Service Environment.

    Supporting Types

    GetAppServiceEnvironmentClusterSetting

    Name string
    The name of this App Service Environment.
    Value string
    The value for the Cluster Setting.
    Name string
    The name of this App Service Environment.
    Value string
    The value for the Cluster Setting.
    name String
    The name of this App Service Environment.
    value String
    The value for the Cluster Setting.
    name string
    The name of this App Service Environment.
    value string
    The value for the Cluster Setting.
    name str
    The name of this App Service Environment.
    value str
    The value for the Cluster Setting.
    name String
    The name of this App Service Environment.
    value String
    The value for the Cluster Setting.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.