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

We recommend using Azure Native.

Azure v6.13.0 published on Monday, Dec 9, 2024 by Pulumi

azure.appservice.getEnvironmentV3

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.13.0 published on Monday, Dec 9, 2024 by Pulumi

    Use this data source to access information about an existing 3rd Generation (v3) App Service Environment.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = azure.appservice.getEnvironmentV3({
        name: "example-ASE",
        resourceGroupName: "example-resource-group",
    });
    export const id = example.then(example => example.id);
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.appservice.get_environment_v3(name="example-ASE",
        resource_group_name="example-resource-group")
    pulumi.export("id", example.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/appservice"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := appservice.LookupEnvironmentV3(ctx, &appservice.LookupEnvironmentV3Args{
    			Name:              "example-ASE",
    			ResourceGroupName: "example-resource-group",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("id", example.Id)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Azure.AppService.GetEnvironmentV3.Invoke(new()
        {
            Name = "example-ASE",
            ResourceGroupName = "example-resource-group",
        });
    
        return new Dictionary<string, object?>
        {
            ["id"] = example.Apply(getEnvironmentV3Result => getEnvironmentV3Result.Id),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.appservice.AppserviceFunctions;
    import com.pulumi.azure.appservice.inputs.GetEnvironmentV3Args;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = AppserviceFunctions.getEnvironmentV3(GetEnvironmentV3Args.builder()
                .name("example-ASE")
                .resourceGroupName("example-resource-group")
                .build());
    
            ctx.export("id", example.applyValue(getEnvironmentV3Result -> getEnvironmentV3Result.id()));
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: azure:appservice:getEnvironmentV3
          Arguments:
            name: example-ASE
            resourceGroupName: example-resource-group
    outputs:
      id: ${example.id}
    

    Using getEnvironmentV3

    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 getEnvironmentV3(args: GetEnvironmentV3Args, opts?: InvokeOptions): Promise<GetEnvironmentV3Result>
    function getEnvironmentV3Output(args: GetEnvironmentV3OutputArgs, opts?: InvokeOptions): Output<GetEnvironmentV3Result>
    def get_environment_v3(name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetEnvironmentV3Result
    def get_environment_v3_output(name: Optional[pulumi.Input[str]] = None,
                           resource_group_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetEnvironmentV3Result]
    func LookupEnvironmentV3(ctx *Context, args *LookupEnvironmentV3Args, opts ...InvokeOption) (*LookupEnvironmentV3Result, error)
    func LookupEnvironmentV3Output(ctx *Context, args *LookupEnvironmentV3OutputArgs, opts ...InvokeOption) LookupEnvironmentV3ResultOutput

    > Note: This function is named LookupEnvironmentV3 in the Go SDK.

    public static class GetEnvironmentV3 
    {
        public static Task<GetEnvironmentV3Result> InvokeAsync(GetEnvironmentV3Args args, InvokeOptions? opts = null)
        public static Output<GetEnvironmentV3Result> Invoke(GetEnvironmentV3InvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEnvironmentV3Result> getEnvironmentV3(GetEnvironmentV3Args args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure:appservice/getEnvironmentV3:getEnvironmentV3
      arguments:
        # arguments dictionary

    The following arguments are supported:

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

    getEnvironmentV3 Result

    The following output properties are available:

    AllowNewPrivateEndpointConnections bool
    Are new Private Endpoint Connections allowed.
    ClusterSettings List<GetEnvironmentV3ClusterSetting>
    A cluster_setting block as defined below.
    DedicatedHostCount int
    The number of Dedicated Hosts used by this ASEv3.
    DnsSuffix string
    the DNS suffix for this App Service Environment V3.
    ExternalInboundIpAddresses List<string>
    The external inbound IP addresses of the App Service Environment V3.
    Id string
    The provider-assigned unique ID for this managed resource.
    InboundNetworkDependencies List<GetEnvironmentV3InboundNetworkDependency>
    An Inbound Network Dependencies block as defined below.
    InternalInboundIpAddresses List<string>
    The internal inbound IP addresses of the App Service Environment V3.
    InternalLoadBalancingMode string
    The Internal Load Balancing Mode of this ASEv3.
    IpSslAddressCount int
    The number of IP SSL addresses reserved for the App Service Environment V3.
    LinuxOutboundIpAddresses List<string>
    The list of Outbound IP Addresses of Linux based Apps in this App Service Environment V3.
    Location string
    The location where the App Service Environment exists.
    Name string
    The name of the Cluster Setting.
    PricingTier string
    Pricing tier for the front end instances.
    RemoteDebuggingEnabled bool
    ResourceGroupName string
    SubnetId string
    The ID of the v3 App Service Environment Subnet.
    Tags Dictionary<string, string>
    A mapping of tags assigned to the v3 App Service Environment.
    WindowsOutboundIpAddresses List<string>
    Outbound addresses of Windows based Apps in this App Service Environment V3.
    ZoneRedundant bool
    AllowNewPrivateEndpointConnections bool
    Are new Private Endpoint Connections allowed.
    ClusterSettings []GetEnvironmentV3ClusterSetting
    A cluster_setting block as defined below.
    DedicatedHostCount int
    The number of Dedicated Hosts used by this ASEv3.
    DnsSuffix string
    the DNS suffix for this App Service Environment V3.
    ExternalInboundIpAddresses []string
    The external inbound IP addresses of the App Service Environment V3.
    Id string
    The provider-assigned unique ID for this managed resource.
    InboundNetworkDependencies []GetEnvironmentV3InboundNetworkDependency
    An Inbound Network Dependencies block as defined below.
    InternalInboundIpAddresses []string
    The internal inbound IP addresses of the App Service Environment V3.
    InternalLoadBalancingMode string
    The Internal Load Balancing Mode of this ASEv3.
    IpSslAddressCount int
    The number of IP SSL addresses reserved for the App Service Environment V3.
    LinuxOutboundIpAddresses []string
    The list of Outbound IP Addresses of Linux based Apps in this App Service Environment V3.
    Location string
    The location where the App Service Environment exists.
    Name string
    The name of the Cluster Setting.
    PricingTier string
    Pricing tier for the front end instances.
    RemoteDebuggingEnabled bool
    ResourceGroupName string
    SubnetId string
    The ID of the v3 App Service Environment Subnet.
    Tags map[string]string
    A mapping of tags assigned to the v3 App Service Environment.
    WindowsOutboundIpAddresses []string
    Outbound addresses of Windows based Apps in this App Service Environment V3.
    ZoneRedundant bool
    allowNewPrivateEndpointConnections Boolean
    Are new Private Endpoint Connections allowed.
    clusterSettings List<GetEnvironmentV3ClusterSetting>
    A cluster_setting block as defined below.
    dedicatedHostCount Integer
    The number of Dedicated Hosts used by this ASEv3.
    dnsSuffix String
    the DNS suffix for this App Service Environment V3.
    externalInboundIpAddresses List<String>
    The external inbound IP addresses of the App Service Environment V3.
    id String
    The provider-assigned unique ID for this managed resource.
    inboundNetworkDependencies List<GetEnvironmentV3InboundNetworkDependency>
    An Inbound Network Dependencies block as defined below.
    internalInboundIpAddresses List<String>
    The internal inbound IP addresses of the App Service Environment V3.
    internalLoadBalancingMode String
    The Internal Load Balancing Mode of this ASEv3.
    ipSslAddressCount Integer
    The number of IP SSL addresses reserved for the App Service Environment V3.
    linuxOutboundIpAddresses List<String>
    The list of Outbound IP Addresses of Linux based Apps in this App Service Environment V3.
    location String
    The location where the App Service Environment exists.
    name String
    The name of the Cluster Setting.
    pricingTier String
    Pricing tier for the front end instances.
    remoteDebuggingEnabled Boolean
    resourceGroupName String
    subnetId String
    The ID of the v3 App Service Environment Subnet.
    tags Map<String,String>
    A mapping of tags assigned to the v3 App Service Environment.
    windowsOutboundIpAddresses List<String>
    Outbound addresses of Windows based Apps in this App Service Environment V3.
    zoneRedundant Boolean
    allowNewPrivateEndpointConnections boolean
    Are new Private Endpoint Connections allowed.
    clusterSettings GetEnvironmentV3ClusterSetting[]
    A cluster_setting block as defined below.
    dedicatedHostCount number
    The number of Dedicated Hosts used by this ASEv3.
    dnsSuffix string
    the DNS suffix for this App Service Environment V3.
    externalInboundIpAddresses string[]
    The external inbound IP addresses of the App Service Environment V3.
    id string
    The provider-assigned unique ID for this managed resource.
    inboundNetworkDependencies GetEnvironmentV3InboundNetworkDependency[]
    An Inbound Network Dependencies block as defined below.
    internalInboundIpAddresses string[]
    The internal inbound IP addresses of the App Service Environment V3.
    internalLoadBalancingMode string
    The Internal Load Balancing Mode of this ASEv3.
    ipSslAddressCount number
    The number of IP SSL addresses reserved for the App Service Environment V3.
    linuxOutboundIpAddresses string[]
    The list of Outbound IP Addresses of Linux based Apps in this App Service Environment V3.
    location string
    The location where the App Service Environment exists.
    name string
    The name of the Cluster Setting.
    pricingTier string
    Pricing tier for the front end instances.
    remoteDebuggingEnabled boolean
    resourceGroupName string
    subnetId string
    The ID of the v3 App Service Environment Subnet.
    tags {[key: string]: string}
    A mapping of tags assigned to the v3 App Service Environment.
    windowsOutboundIpAddresses string[]
    Outbound addresses of Windows based Apps in this App Service Environment V3.
    zoneRedundant boolean
    allow_new_private_endpoint_connections bool
    Are new Private Endpoint Connections allowed.
    cluster_settings Sequence[GetEnvironmentV3ClusterSetting]
    A cluster_setting block as defined below.
    dedicated_host_count int
    The number of Dedicated Hosts used by this ASEv3.
    dns_suffix str
    the DNS suffix for this App Service Environment V3.
    external_inbound_ip_addresses Sequence[str]
    The external inbound IP addresses of the App Service Environment V3.
    id str
    The provider-assigned unique ID for this managed resource.
    inbound_network_dependencies Sequence[GetEnvironmentV3InboundNetworkDependency]
    An Inbound Network Dependencies block as defined below.
    internal_inbound_ip_addresses Sequence[str]
    The internal inbound IP addresses of the App Service Environment V3.
    internal_load_balancing_mode str
    The Internal Load Balancing Mode of this ASEv3.
    ip_ssl_address_count int
    The number of IP SSL addresses reserved for the App Service Environment V3.
    linux_outbound_ip_addresses Sequence[str]
    The list of Outbound IP Addresses of Linux based Apps in this App Service Environment V3.
    location str
    The location where the App Service Environment exists.
    name str
    The name of the Cluster Setting.
    pricing_tier str
    Pricing tier for the front end instances.
    remote_debugging_enabled bool
    resource_group_name str
    subnet_id str
    The ID of the v3 App Service Environment Subnet.
    tags Mapping[str, str]
    A mapping of tags assigned to the v3 App Service Environment.
    windows_outbound_ip_addresses Sequence[str]
    Outbound addresses of Windows based Apps in this App Service Environment V3.
    zone_redundant bool
    allowNewPrivateEndpointConnections Boolean
    Are new Private Endpoint Connections allowed.
    clusterSettings List<Property Map>
    A cluster_setting block as defined below.
    dedicatedHostCount Number
    The number of Dedicated Hosts used by this ASEv3.
    dnsSuffix String
    the DNS suffix for this App Service Environment V3.
    externalInboundIpAddresses List<String>
    The external inbound IP addresses of the App Service Environment V3.
    id String
    The provider-assigned unique ID for this managed resource.
    inboundNetworkDependencies List<Property Map>
    An Inbound Network Dependencies block as defined below.
    internalInboundIpAddresses List<String>
    The internal inbound IP addresses of the App Service Environment V3.
    internalLoadBalancingMode String
    The Internal Load Balancing Mode of this ASEv3.
    ipSslAddressCount Number
    The number of IP SSL addresses reserved for the App Service Environment V3.
    linuxOutboundIpAddresses List<String>
    The list of Outbound IP Addresses of Linux based Apps in this App Service Environment V3.
    location String
    The location where the App Service Environment exists.
    name String
    The name of the Cluster Setting.
    pricingTier String
    Pricing tier for the front end instances.
    remoteDebuggingEnabled Boolean
    resourceGroupName String
    subnetId String
    The ID of the v3 App Service Environment Subnet.
    tags Map<String>
    A mapping of tags assigned to the v3 App Service Environment.
    windowsOutboundIpAddresses List<String>
    Outbound addresses of Windows based Apps in this App Service Environment V3.
    zoneRedundant Boolean

    Supporting Types

    GetEnvironmentV3ClusterSetting

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

    GetEnvironmentV3InboundNetworkDependency

    Description string
    A short description of the purpose of the network traffic.
    IpAddresses List<string>
    A list of IP addresses that network traffic will originate from in CIDR notation.
    Ports List<string>
    The ports that network traffic will arrive to the App Service Environment V3 on.
    Description string
    A short description of the purpose of the network traffic.
    IpAddresses []string
    A list of IP addresses that network traffic will originate from in CIDR notation.
    Ports []string
    The ports that network traffic will arrive to the App Service Environment V3 on.
    description String
    A short description of the purpose of the network traffic.
    ipAddresses List<String>
    A list of IP addresses that network traffic will originate from in CIDR notation.
    ports List<String>
    The ports that network traffic will arrive to the App Service Environment V3 on.
    description string
    A short description of the purpose of the network traffic.
    ipAddresses string[]
    A list of IP addresses that network traffic will originate from in CIDR notation.
    ports string[]
    The ports that network traffic will arrive to the App Service Environment V3 on.
    description str
    A short description of the purpose of the network traffic.
    ip_addresses Sequence[str]
    A list of IP addresses that network traffic will originate from in CIDR notation.
    ports Sequence[str]
    The ports that network traffic will arrive to the App Service Environment V3 on.
    description String
    A short description of the purpose of the network traffic.
    ipAddresses List<String>
    A list of IP addresses that network traffic will originate from in CIDR notation.
    ports List<String>
    The ports that network traffic will arrive to the App Service Environment V3 on.

    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.

    Azure v6.13.0 published on Monday, Dec 9, 2024 by Pulumi