Azure Classic v5.38.0, Mar 21 23

azure.containerapp.getEnvironment

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

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.ContainerApp.GetEnvironment.Invoke(new()
    {
        Name = "example-environment",
        ResourceGroupName = "example-resources",
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/containerapp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := containerapp.LookupEnvironment(ctx, &containerapp.LookupEnvironmentArgs{
			Name:              "example-environment",
			ResourceGroupName: "example-resources",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.containerapp.ContainerappFunctions;
import com.pulumi.azure.containerapp.inputs.GetEnvironmentArgs;
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 = ContainerappFunctions.getEnvironment(GetEnvironmentArgs.builder()
            .name("example-environment")
            .resourceGroupName("example-resources")
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example = azure.containerapp.get_environment(name="example-environment",
    resource_group_name="example-resources")

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.containerapp.getEnvironment({
    name: "example-environment",
    resourceGroupName: "example-resources",
});

variables:
  example:
    fn::invoke:
      Function: azure:containerapp:getEnvironment
      Arguments:
        name: example-environment
        resourceGroupName: example-resources

Using getEnvironment

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 getEnvironment(args: GetEnvironmentArgs, opts?: InvokeOptions): Promise<GetEnvironmentResult>
function getEnvironmentOutput(args: GetEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentResult>

def get_environment(name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEnvironmentResult
def get_environment_output(name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetEnvironmentResult]

func LookupEnvironment(ctx *Context, args *LookupEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentResult, error)
func LookupEnvironmentOutput(ctx *Context, args *LookupEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentResultOutput

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

public static class GetEnvironment 
{
    public static Task<GetEnvironmentResult> InvokeAsync(GetEnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetEnvironmentResult> Invoke(GetEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure:containerapp/getEnvironment:getEnvironment
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of the Container Apps Managed Environment.
ResourceGroupName string: The name of the Resource Group where this Container App Environment exists.

Name string: The name of the Container Apps Managed Environment.
ResourceGroupName string: The name of the Resource Group where this Container App Environment exists.

name String: The name of the Container Apps Managed Environment.
resourceGroupName String: The name of the Resource Group where this Container App Environment exists.

name string: The name of the Container Apps Managed Environment.
resourceGroupName string: The name of the Resource Group where this Container App Environment exists.

name str: The name of the Container Apps Managed Environment.
resource_group_name str: The name of the Resource Group where this Container App Environment exists.

name String: The name of the Container Apps Managed Environment.
resourceGroupName String: The name of the Resource Group where this Container App Environment exists.

getEnvironment Result

The following output properties are available:

DefaultDomain string: The default publicly resolvable name of this Container App Environment. This is generated at creation time to be globally unique.
DockerBridgeCidr string: The network addressing in which the Container Apps in this Container App Environment will reside in CIDR notation.
Id string: The provider-assigned unique ID for this managed resource.
InfrastructureSubnetId string: The ID of the Subnet in use by the Container Apps Control Plane.
InternalLoadBalancerEnabled bool: Does the Container App Environment operate in Internal Load Balancing Mode?
Location string: The Azure Location where this Container App Environment exists.
LogAnalyticsWorkspaceName string: The name of the Log Analytics Workspace this Container Apps Managed Environment is linked to.
Name string
PlatformReservedCidr string: The IP range, in CIDR notation, that is reserved for environment infrastructure IP addresses.
PlatformReservedDnsIpAddress string: The IP address from the IP range defined by platform_reserved_cidr that is reserved for the internal DNS server.
ResourceGroupName string
StaticIpAddress string
Tags Dictionary<string, string>: A mapping of tags assigned to the resource.

DefaultDomain string: The default publicly resolvable name of this Container App Environment. This is generated at creation time to be globally unique.
DockerBridgeCidr string: The network addressing in which the Container Apps in this Container App Environment will reside in CIDR notation.
Id string: The provider-assigned unique ID for this managed resource.
InfrastructureSubnetId string: The ID of the Subnet in use by the Container Apps Control Plane.
InternalLoadBalancerEnabled bool: Does the Container App Environment operate in Internal Load Balancing Mode?
Location string: The Azure Location where this Container App Environment exists.
LogAnalyticsWorkspaceName string: The name of the Log Analytics Workspace this Container Apps Managed Environment is linked to.
Name string
PlatformReservedCidr string: The IP range, in CIDR notation, that is reserved for environment infrastructure IP addresses.
PlatformReservedDnsIpAddress string: The IP address from the IP range defined by platform_reserved_cidr that is reserved for the internal DNS server.
ResourceGroupName string
StaticIpAddress string
Tags map[string]string: A mapping of tags assigned to the resource.

defaultDomain String: The default publicly resolvable name of this Container App Environment. This is generated at creation time to be globally unique.
dockerBridgeCidr String: The network addressing in which the Container Apps in this Container App Environment will reside in CIDR notation.
id String: The provider-assigned unique ID for this managed resource.
infrastructureSubnetId String: The ID of the Subnet in use by the Container Apps Control Plane.
internalLoadBalancerEnabled Boolean: Does the Container App Environment operate in Internal Load Balancing Mode?
location String: The Azure Location where this Container App Environment exists.
logAnalyticsWorkspaceName String: The name of the Log Analytics Workspace this Container Apps Managed Environment is linked to.
name String
platformReservedCidr String: The IP range, in CIDR notation, that is reserved for environment infrastructure IP addresses.
platformReservedDnsIpAddress String: The IP address from the IP range defined by platform_reserved_cidr that is reserved for the internal DNS server.
resourceGroupName String
staticIpAddress String
tags Map<String,String>: A mapping of tags assigned to the resource.

defaultDomain string: The default publicly resolvable name of this Container App Environment. This is generated at creation time to be globally unique.
dockerBridgeCidr string: The network addressing in which the Container Apps in this Container App Environment will reside in CIDR notation.
id string: The provider-assigned unique ID for this managed resource.
infrastructureSubnetId string: The ID of the Subnet in use by the Container Apps Control Plane.
internalLoadBalancerEnabled boolean: Does the Container App Environment operate in Internal Load Balancing Mode?
location string: The Azure Location where this Container App Environment exists.
logAnalyticsWorkspaceName string: The name of the Log Analytics Workspace this Container Apps Managed Environment is linked to.
name string
platformReservedCidr string: The IP range, in CIDR notation, that is reserved for environment infrastructure IP addresses.
platformReservedDnsIpAddress string: The IP address from the IP range defined by platform_reserved_cidr that is reserved for the internal DNS server.
resourceGroupName string
staticIpAddress string
tags {[key: string]: string}: A mapping of tags assigned to the resource.

default_domain str: The default publicly resolvable name of this Container App Environment. This is generated at creation time to be globally unique.
docker_bridge_cidr str: The network addressing in which the Container Apps in this Container App Environment will reside in CIDR notation.
id str: The provider-assigned unique ID for this managed resource.
infrastructure_subnet_id str: The ID of the Subnet in use by the Container Apps Control Plane.
internal_load_balancer_enabled bool: Does the Container App Environment operate in Internal Load Balancing Mode?
location str: The Azure Location where this Container App Environment exists.
log_analytics_workspace_name str: The name of the Log Analytics Workspace this Container Apps Managed Environment is linked to.
name str
platform_reserved_cidr str: The IP range, in CIDR notation, that is reserved for environment infrastructure IP addresses.
platform_reserved_dns_ip_address str: The IP address from the IP range defined by platform_reserved_cidr that is reserved for the internal DNS server.
resource_group_name str
static_ip_address str
tags Mapping[str, str]: A mapping of tags assigned to the resource.

defaultDomain String: The default publicly resolvable name of this Container App Environment. This is generated at creation time to be globally unique.
dockerBridgeCidr String: The network addressing in which the Container Apps in this Container App Environment will reside in CIDR notation.
id String: The provider-assigned unique ID for this managed resource.
infrastructureSubnetId String: The ID of the Subnet in use by the Container Apps Control Plane.
internalLoadBalancerEnabled Boolean: Does the Container App Environment operate in Internal Load Balancing Mode?
location String: The Azure Location where this Container App Environment exists.
logAnalyticsWorkspaceName String: The name of the Log Analytics Workspace this Container Apps Managed Environment is linked to.
name String
platformReservedCidr String: The IP range, in CIDR notation, that is reserved for environment infrastructure IP addresses.
platformReservedDnsIpAddress String: The IP address from the IP range defined by platform_reserved_cidr that is reserved for the internal DNS server.
resourceGroupName String
staticIpAddress String
tags Map<String>: A mapping of tags assigned to the resource.

Package Details

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

azure.containerapp.getEnvironment

Example Usage

Using getEnvironment

getEnvironment Result

Package Details

Contents