Docs Packages
  1. Packages
  2. Azure Classic
  3. API Docs
  4. containerapp
  5. Environment

We recommend using Azure Native.

Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure

azure.containerapp.Environment

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Container App Environment.

    Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleAnalyticsWorkspace = new azure.operationalinsights.AnalyticsWorkspace("example", {
    name: "acctest-01",
    location: example.location,
    resourceGroupName: example.name,
    sku: "PerGB2018",
    retentionInDays: 30,
});
const exampleEnvironment = new azure.containerapp.Environment("example", {
    name: "my-environment",
    location: example.location,
    resourceGroupName: example.name,
    logAnalyticsWorkspaceId: exampleAnalyticsWorkspace.id,
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_analytics_workspace = azure.operationalinsights.AnalyticsWorkspace("example",
    name="acctest-01",
    location=example.location,
    resource_group_name=example.name,
    sku="PerGB2018",
    retention_in_days=30)
example_environment = azure.containerapp.Environment("example",
    name="my-environment",
    location=example.location,
    resource_group_name=example.name,
    log_analytics_workspace_id=example_analytics_workspace.id)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAnalyticsWorkspace, err := operationalinsights.NewAnalyticsWorkspace(ctx, "example", &operationalinsights.AnalyticsWorkspaceArgs{
			Name:              pulumi.String("acctest-01"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Sku:               pulumi.String("PerGB2018"),
			RetentionInDays:   pulumi.Int(30),
		})
		if err != nil {
			return err
		}
		_, err = containerapp.NewEnvironment(ctx, "example", &containerapp.EnvironmentArgs{
			Name:                    pulumi.String("my-environment"),
			Location:                example.Location,
			ResourceGroupName:       example.Name,
			LogAnalyticsWorkspaceId: exampleAnalyticsWorkspace.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleAnalyticsWorkspace = new Azure.OperationalInsights.AnalyticsWorkspace("example", new()
    {
        Name = "acctest-01",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Sku = "PerGB2018",
        RetentionInDays = 30,
    });

    var exampleEnvironment = new Azure.ContainerApp.Environment("example", new()
    {
        Name = "my-environment",
        Location = example.Location,
        ResourceGroupName = example.Name,
        LogAnalyticsWorkspaceId = exampleAnalyticsWorkspace.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.operationalinsights.AnalyticsWorkspace;
import com.pulumi.azure.operationalinsights.AnalyticsWorkspaceArgs;
import com.pulumi.azure.containerapp.Environment;
import com.pulumi.azure.containerapp.EnvironmentArgs;
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) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()        
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleAnalyticsWorkspace = new AnalyticsWorkspace("exampleAnalyticsWorkspace", AnalyticsWorkspaceArgs.builder()        
            .name("acctest-01")
            .location(example.location())
            .resourceGroupName(example.name())
            .sku("PerGB2018")
            .retentionInDays(30)
            .build());

        var exampleEnvironment = new Environment("exampleEnvironment", EnvironmentArgs.builder()        
            .name("my-environment")
            .location(example.location())
            .resourceGroupName(example.name())
            .logAnalyticsWorkspaceId(exampleAnalyticsWorkspace.id())
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleAnalyticsWorkspace:
    type: azure:operationalinsights:AnalyticsWorkspace
    name: example
    properties:
      name: acctest-01
      location: ${example.location}
      resourceGroupName: ${example.name}
      sku: PerGB2018
      retentionInDays: 30
  exampleEnvironment:
    type: azure:containerapp:Environment
    name: example
    properties:
      name: my-environment
      location: ${example.location}
      resourceGroupName: ${example.name}
      logAnalyticsWorkspaceId: ${exampleAnalyticsWorkspace.id}

    Create Environment Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Environment(name: string, args: EnvironmentArgs, opts?: CustomResourceOptions);
    @overload
def Environment(resource_name: str,
                args: EnvironmentArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def Environment(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                resource_group_name: Optional[str] = None,
                dapr_application_insights_connection_string: Optional[str] = None,
                infrastructure_resource_group_name: Optional[str] = None,
                infrastructure_subnet_id: Optional[str] = None,
                internal_load_balancer_enabled: Optional[bool] = None,
                location: Optional[str] = None,
                log_analytics_workspace_id: Optional[str] = None,
                name: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                workload_profiles: Optional[Sequence[EnvironmentWorkloadProfileArgs]] = None,
                zone_redundancy_enabled: Optional[bool] = None)
    func NewEnvironment(ctx *Context, name string, args EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
    public Environment(string name, EnvironmentArgs args, CustomResourceOptions? opts = null)
    public Environment(String name, EnvironmentArgs args)
public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)

    type: azure:containerapp:Environment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var azureEnvironmentResource = new Azure.ContainerApp.Environment("azureEnvironmentResource", new()
{
    ResourceGroupName = "string",
    DaprApplicationInsightsConnectionString = "string",
    InfrastructureResourceGroupName = "string",
    InfrastructureSubnetId = "string",
    InternalLoadBalancerEnabled = false,
    Location = "string",
    LogAnalyticsWorkspaceId = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
    WorkloadProfiles = new[]
    {
        new Azure.ContainerApp.Inputs.EnvironmentWorkloadProfileArgs
        {
            Name = "string",
            WorkloadProfileType = "string",
            MaximumCount = 0,
            MinimumCount = 0,
        },
    },
    ZoneRedundancyEnabled = false,
});

    example, err := containerapp.NewEnvironment(ctx, "azureEnvironmentResource", &containerapp.EnvironmentArgs{
	ResourceGroupName:                       pulumi.String("string"),
	DaprApplicationInsightsConnectionString: pulumi.String("string"),
	InfrastructureResourceGroupName:         pulumi.String("string"),
	InfrastructureSubnetId:                  pulumi.String("string"),
	InternalLoadBalancerEnabled:             pulumi.Bool(false),
	Location:                                pulumi.String("string"),
	LogAnalyticsWorkspaceId:                 pulumi.String("string"),
	Name:                                    pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	WorkloadProfiles: containerapp.EnvironmentWorkloadProfileArray{
		&containerapp.EnvironmentWorkloadProfileArgs{
			Name:                pulumi.String("string"),
			WorkloadProfileType: pulumi.String("string"),
			MaximumCount:        pulumi.Int(0),
			MinimumCount:        pulumi.Int(0),
		},
	},
	ZoneRedundancyEnabled: pulumi.Bool(false),
})

    var azureEnvironmentResource = new Environment("azureEnvironmentResource", EnvironmentArgs.builder()        
    .resourceGroupName("string")
    .daprApplicationInsightsConnectionString("string")
    .infrastructureResourceGroupName("string")
    .infrastructureSubnetId("string")
    .internalLoadBalancerEnabled(false)
    .location("string")
    .logAnalyticsWorkspaceId("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .workloadProfiles(EnvironmentWorkloadProfileArgs.builder()
        .name("string")
        .workloadProfileType("string")
        .maximumCount(0)
        .minimumCount(0)
        .build())
    .zoneRedundancyEnabled(false)
    .build());

    azure_environment_resource = azure.containerapp.Environment("azureEnvironmentResource",
    resource_group_name="string",
    dapr_application_insights_connection_string="string",
    infrastructure_resource_group_name="string",
    infrastructure_subnet_id="string",
    internal_load_balancer_enabled=False,
    location="string",
    log_analytics_workspace_id="string",
    name="string",
    tags={
        "string": "string",
    },
    workload_profiles=[azure.containerapp.EnvironmentWorkloadProfileArgs(
        name="string",
        workload_profile_type="string",
        maximum_count=0,
        minimum_count=0,
    )],
    zone_redundancy_enabled=False)

    const azureEnvironmentResource = new azure.containerapp.Environment("azureEnvironmentResource", {
    resourceGroupName: "string",
    daprApplicationInsightsConnectionString: "string",
    infrastructureResourceGroupName: "string",
    infrastructureSubnetId: "string",
    internalLoadBalancerEnabled: false,
    location: "string",
    logAnalyticsWorkspaceId: "string",
    name: "string",
    tags: {
        string: "string",
    },
    workloadProfiles: [{
        name: "string",
        workloadProfileType: "string",
        maximumCount: 0,
        minimumCount: 0,
    }],
    zoneRedundancyEnabled: false,
});

    type: azure:containerapp:Environment
properties:
    daprApplicationInsightsConnectionString: string
    infrastructureResourceGroupName: string
    infrastructureSubnetId: string
    internalLoadBalancerEnabled: false
    location: string
    logAnalyticsWorkspaceId: string
    name: string
    resourceGroupName: string
    tags:
        string: string
    workloadProfiles:
        - maximumCount: 0
          minimumCount: 0
          name: string
          workloadProfileType: string
    zoneRedundancyEnabled: false

    Environment Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Environment resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group in which the Container App Environment is to be created. Changing this forces a new resource to be created.
    DaprApplicationInsightsConnectionString string
    Application Insights connection string used by Dapr to export Service to Service communication telemetry. Changing this forces a new resource to be created.
    InfrastructureResourceGroupName string

    Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. Changing this forces a new resource to be created.

    Note: Only valid if a workload_profile is specified. If infrastructure_subnet_id is specified, this resource group will be created in the same subscription as infrastructure_subnet_id.

    InfrastructureSubnetId string

    The existing Subnet to use for the Container Apps Control Plane. Changing this forces a new resource to be created.

    NOTE: The Subnet must have a /21 or larger address space.

    InternalLoadBalancerEnabled bool

    Should the Container Environment operate in Internal Load Balancing Mode? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    Location string
    Specifies the supported Azure location where the Container App Environment is to exist. Changing this forces a new resource to be created.
    LogAnalyticsWorkspaceId string
    The ID for the Log Analytics Workspace to link this Container Apps Managed Environment to. Changing this forces a new resource to be created.
    Name string
    The name of the Container Apps Managed Environment. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    WorkloadProfiles List<EnvironmentWorkloadProfile>
    The profile of the workload to scope the container app execution. A workload_profile block as defined below.
    ZoneRedundancyEnabled bool

    Should the Container App Environment be created with Zone Redundancy enabled? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    ResourceGroupName string
    The name of the resource group in which the Container App Environment is to be created. Changing this forces a new resource to be created.
    DaprApplicationInsightsConnectionString string
    Application Insights connection string used by Dapr to export Service to Service communication telemetry. Changing this forces a new resource to be created.
    InfrastructureResourceGroupName string

    Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. Changing this forces a new resource to be created.

    Note: Only valid if a workload_profile is specified. If infrastructure_subnet_id is specified, this resource group will be created in the same subscription as infrastructure_subnet_id.

    InfrastructureSubnetId string

    The existing Subnet to use for the Container Apps Control Plane. Changing this forces a new resource to be created.

    NOTE: The Subnet must have a /21 or larger address space.

    InternalLoadBalancerEnabled bool

    Should the Container Environment operate in Internal Load Balancing Mode? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    Location string
    Specifies the supported Azure location where the Container App Environment is to exist. Changing this forces a new resource to be created.
    LogAnalyticsWorkspaceId string
    The ID for the Log Analytics Workspace to link this Container Apps Managed Environment to. Changing this forces a new resource to be created.
    Name string
    The name of the Container Apps Managed Environment. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    WorkloadProfiles []EnvironmentWorkloadProfileArgs
    The profile of the workload to scope the container app execution. A workload_profile block as defined below.
    ZoneRedundancyEnabled bool

    Should the Container App Environment be created with Zone Redundancy enabled? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    resourceGroupName String
    The name of the resource group in which the Container App Environment is to be created. Changing this forces a new resource to be created.
    daprApplicationInsightsConnectionString String
    Application Insights connection string used by Dapr to export Service to Service communication telemetry. Changing this forces a new resource to be created.
    infrastructureResourceGroupName String

    Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. Changing this forces a new resource to be created.

    Note: Only valid if a workload_profile is specified. If infrastructure_subnet_id is specified, this resource group will be created in the same subscription as infrastructure_subnet_id.

    infrastructureSubnetId String

    The existing Subnet to use for the Container Apps Control Plane. Changing this forces a new resource to be created.

    NOTE: The Subnet must have a /21 or larger address space.

    internalLoadBalancerEnabled Boolean

    Should the Container Environment operate in Internal Load Balancing Mode? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    location String
    Specifies the supported Azure location where the Container App Environment is to exist. Changing this forces a new resource to be created.
    logAnalyticsWorkspaceId String
    The ID for the Log Analytics Workspace to link this Container Apps Managed Environment to. Changing this forces a new resource to be created.
    name String
    The name of the Container Apps Managed Environment. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    workloadProfiles List<EnvironmentWorkloadProfile>
    The profile of the workload to scope the container app execution. A workload_profile block as defined below.
    zoneRedundancyEnabled Boolean

    Should the Container App Environment be created with Zone Redundancy enabled? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    resourceGroupName string
    The name of the resource group in which the Container App Environment is to be created. Changing this forces a new resource to be created.
    daprApplicationInsightsConnectionString string
    Application Insights connection string used by Dapr to export Service to Service communication telemetry. Changing this forces a new resource to be created.
    infrastructureResourceGroupName string

    Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. Changing this forces a new resource to be created.

    Note: Only valid if a workload_profile is specified. If infrastructure_subnet_id is specified, this resource group will be created in the same subscription as infrastructure_subnet_id.

    infrastructureSubnetId string

    The existing Subnet to use for the Container Apps Control Plane. Changing this forces a new resource to be created.

    NOTE: The Subnet must have a /21 or larger address space.

    internalLoadBalancerEnabled boolean

    Should the Container Environment operate in Internal Load Balancing Mode? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    location string
    Specifies the supported Azure location where the Container App Environment is to exist. Changing this forces a new resource to be created.
    logAnalyticsWorkspaceId string
    The ID for the Log Analytics Workspace to link this Container Apps Managed Environment to. Changing this forces a new resource to be created.
    name string
    The name of the Container Apps Managed Environment. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    workloadProfiles EnvironmentWorkloadProfile[]
    The profile of the workload to scope the container app execution. A workload_profile block as defined below.
    zoneRedundancyEnabled boolean

    Should the Container App Environment be created with Zone Redundancy enabled? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    resource_group_name str
    The name of the resource group in which the Container App Environment is to be created. Changing this forces a new resource to be created.
    dapr_application_insights_connection_string str
    Application Insights connection string used by Dapr to export Service to Service communication telemetry. Changing this forces a new resource to be created.
    infrastructure_resource_group_name str

    Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. Changing this forces a new resource to be created.

    Note: Only valid if a workload_profile is specified. If infrastructure_subnet_id is specified, this resource group will be created in the same subscription as infrastructure_subnet_id.

    infrastructure_subnet_id str

    The existing Subnet to use for the Container Apps Control Plane. Changing this forces a new resource to be created.

    NOTE: The Subnet must have a /21 or larger address space.

    internal_load_balancer_enabled bool

    Should the Container Environment operate in Internal Load Balancing Mode? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    location str
    Specifies the supported Azure location where the Container App Environment is to exist. Changing this forces a new resource to be created.
    log_analytics_workspace_id str
    The ID for the Log Analytics Workspace to link this Container Apps Managed Environment to. Changing this forces a new resource to be created.
    name str
    The name of the Container Apps Managed Environment. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    workload_profiles Sequence[EnvironmentWorkloadProfileArgs]
    The profile of the workload to scope the container app execution. A workload_profile block as defined below.
    zone_redundancy_enabled bool

    Should the Container App Environment be created with Zone Redundancy enabled? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    resourceGroupName String
    The name of the resource group in which the Container App Environment is to be created. Changing this forces a new resource to be created.
    daprApplicationInsightsConnectionString String
    Application Insights connection string used by Dapr to export Service to Service communication telemetry. Changing this forces a new resource to be created.
    infrastructureResourceGroupName String

    Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. Changing this forces a new resource to be created.

    Note: Only valid if a workload_profile is specified. If infrastructure_subnet_id is specified, this resource group will be created in the same subscription as infrastructure_subnet_id.

    infrastructureSubnetId String

    The existing Subnet to use for the Container Apps Control Plane. Changing this forces a new resource to be created.

    NOTE: The Subnet must have a /21 or larger address space.

    internalLoadBalancerEnabled Boolean

    Should the Container Environment operate in Internal Load Balancing Mode? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    location String
    Specifies the supported Azure location where the Container App Environment is to exist. Changing this forces a new resource to be created.
    logAnalyticsWorkspaceId String
    The ID for the Log Analytics Workspace to link this Container Apps Managed Environment to. Changing this forces a new resource to be created.
    name String
    The name of the Container Apps Managed Environment. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.
    workloadProfiles List<Property Map>
    The profile of the workload to scope the container app execution. A workload_profile block as defined below.
    zoneRedundancyEnabled Boolean

    Should the Container App Environment be created with Zone Redundancy enabled? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Environment resource produces the following output properties:

    DefaultDomain string
    The default, publicly resolvable, name of this Container App Environment.
    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.
    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.
    StaticIpAddress string
    The Static IP address of the Environment.
    DefaultDomain string
    The default, publicly resolvable, name of this Container App Environment.
    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.
    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.
    StaticIpAddress string
    The Static IP address of the Environment.
    defaultDomain String
    The default, publicly resolvable, name of this Container App Environment.
    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.
    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.
    staticIpAddress String
    The Static IP address of the Environment.
    defaultDomain string
    The default, publicly resolvable, name of this Container App Environment.
    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.
    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.
    staticIpAddress string
    The Static IP address of the Environment.
    default_domain str
    The default, publicly resolvable, name of this Container App Environment.
    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.
    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.
    static_ip_address str
    The Static IP address of the Environment.
    defaultDomain String
    The default, publicly resolvable, name of this Container App Environment.
    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.
    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.
    staticIpAddress String
    The Static IP address of the Environment.

    Look up Existing Environment Resource

    Get an existing Environment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: EnvironmentState, opts?: CustomResourceOptions): Environment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dapr_application_insights_connection_string: Optional[str] = None,
        default_domain: Optional[str] = None,
        docker_bridge_cidr: Optional[str] = None,
        infrastructure_resource_group_name: Optional[str] = None,
        infrastructure_subnet_id: Optional[str] = None,
        internal_load_balancer_enabled: Optional[bool] = None,
        location: Optional[str] = None,
        log_analytics_workspace_id: Optional[str] = None,
        name: Optional[str] = None,
        platform_reserved_cidr: Optional[str] = None,
        platform_reserved_dns_ip_address: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        static_ip_address: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        workload_profiles: Optional[Sequence[EnvironmentWorkloadProfileArgs]] = None,
        zone_redundancy_enabled: Optional[bool] = None) -> Environment
    func GetEnvironment(ctx *Context, name string, id IDInput, state *EnvironmentState, opts ...ResourceOption) (*Environment, error)
    public static Environment Get(string name, Input<string> id, EnvironmentState? state, CustomResourceOptions? opts = null)
    public static Environment get(String name, Output<String> id, EnvironmentState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DaprApplicationInsightsConnectionString string
    Application Insights connection string used by Dapr to export Service to Service communication telemetry. Changing this forces a new resource to be created.
    DefaultDomain string
    The default, publicly resolvable, name of this Container App Environment.
    DockerBridgeCidr string
    The network addressing in which the Container Apps in this Container App Environment will reside in CIDR notation.
    InfrastructureResourceGroupName string

    Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. Changing this forces a new resource to be created.

    Note: Only valid if a workload_profile is specified. If infrastructure_subnet_id is specified, this resource group will be created in the same subscription as infrastructure_subnet_id.

    InfrastructureSubnetId string

    The existing Subnet to use for the Container Apps Control Plane. Changing this forces a new resource to be created.

    NOTE: The Subnet must have a /21 or larger address space.

    InternalLoadBalancerEnabled bool

    Should the Container Environment operate in Internal Load Balancing Mode? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    Location string
    Specifies the supported Azure location where the Container App Environment is to exist. Changing this forces a new resource to be created.
    LogAnalyticsWorkspaceId string
    The ID for the Log Analytics Workspace to link this Container Apps Managed Environment to. Changing this forces a new resource to be created.
    Name string
    The name of the Container Apps Managed Environment. Changing this forces a new resource to be created.
    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
    The name of the resource group in which the Container App Environment is to be created. Changing this forces a new resource to be created.
    StaticIpAddress string
    The Static IP address of the Environment.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    WorkloadProfiles List<EnvironmentWorkloadProfile>
    The profile of the workload to scope the container app execution. A workload_profile block as defined below.
    ZoneRedundancyEnabled bool

    Should the Container App Environment be created with Zone Redundancy enabled? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    DaprApplicationInsightsConnectionString string
    Application Insights connection string used by Dapr to export Service to Service communication telemetry. Changing this forces a new resource to be created.
    DefaultDomain string
    The default, publicly resolvable, name of this Container App Environment.
    DockerBridgeCidr string
    The network addressing in which the Container Apps in this Container App Environment will reside in CIDR notation.
    InfrastructureResourceGroupName string

    Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. Changing this forces a new resource to be created.

    Note: Only valid if a workload_profile is specified. If infrastructure_subnet_id is specified, this resource group will be created in the same subscription as infrastructure_subnet_id.

    InfrastructureSubnetId string

    The existing Subnet to use for the Container Apps Control Plane. Changing this forces a new resource to be created.

    NOTE: The Subnet must have a /21 or larger address space.

    InternalLoadBalancerEnabled bool

    Should the Container Environment operate in Internal Load Balancing Mode? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    Location string
    Specifies the supported Azure location where the Container App Environment is to exist. Changing this forces a new resource to be created.
    LogAnalyticsWorkspaceId string
    The ID for the Log Analytics Workspace to link this Container Apps Managed Environment to. Changing this forces a new resource to be created.
    Name string
    The name of the Container Apps Managed Environment. Changing this forces a new resource to be created.
    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
    The name of the resource group in which the Container App Environment is to be created. Changing this forces a new resource to be created.
    StaticIpAddress string
    The Static IP address of the Environment.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    WorkloadProfiles []EnvironmentWorkloadProfileArgs
    The profile of the workload to scope the container app execution. A workload_profile block as defined below.
    ZoneRedundancyEnabled bool

    Should the Container App Environment be created with Zone Redundancy enabled? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    daprApplicationInsightsConnectionString String
    Application Insights connection string used by Dapr to export Service to Service communication telemetry. Changing this forces a new resource to be created.
    defaultDomain String
    The default, publicly resolvable, name of this Container App Environment.
    dockerBridgeCidr String
    The network addressing in which the Container Apps in this Container App Environment will reside in CIDR notation.
    infrastructureResourceGroupName String

    Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. Changing this forces a new resource to be created.

    Note: Only valid if a workload_profile is specified. If infrastructure_subnet_id is specified, this resource group will be created in the same subscription as infrastructure_subnet_id.

    infrastructureSubnetId String

    The existing Subnet to use for the Container Apps Control Plane. Changing this forces a new resource to be created.

    NOTE: The Subnet must have a /21 or larger address space.

    internalLoadBalancerEnabled Boolean

    Should the Container Environment operate in Internal Load Balancing Mode? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    location String
    Specifies the supported Azure location where the Container App Environment is to exist. Changing this forces a new resource to be created.
    logAnalyticsWorkspaceId String
    The ID for the Log Analytics Workspace to link this Container Apps Managed Environment to. Changing this forces a new resource to be created.
    name String
    The name of the Container Apps Managed Environment. Changing this forces a new resource to be created.
    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
    The name of the resource group in which the Container App Environment is to be created. Changing this forces a new resource to be created.
    staticIpAddress String
    The Static IP address of the Environment.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    workloadProfiles List<EnvironmentWorkloadProfile>
    The profile of the workload to scope the container app execution. A workload_profile block as defined below.
    zoneRedundancyEnabled Boolean

    Should the Container App Environment be created with Zone Redundancy enabled? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    daprApplicationInsightsConnectionString string
    Application Insights connection string used by Dapr to export Service to Service communication telemetry. Changing this forces a new resource to be created.
    defaultDomain string
    The default, publicly resolvable, name of this Container App Environment.
    dockerBridgeCidr string
    The network addressing in which the Container Apps in this Container App Environment will reside in CIDR notation.
    infrastructureResourceGroupName string

    Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. Changing this forces a new resource to be created.

    Note: Only valid if a workload_profile is specified. If infrastructure_subnet_id is specified, this resource group will be created in the same subscription as infrastructure_subnet_id.

    infrastructureSubnetId string

    The existing Subnet to use for the Container Apps Control Plane. Changing this forces a new resource to be created.

    NOTE: The Subnet must have a /21 or larger address space.

    internalLoadBalancerEnabled boolean

    Should the Container Environment operate in Internal Load Balancing Mode? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    location string
    Specifies the supported Azure location where the Container App Environment is to exist. Changing this forces a new resource to be created.
    logAnalyticsWorkspaceId string
    The ID for the Log Analytics Workspace to link this Container Apps Managed Environment to. Changing this forces a new resource to be created.
    name string
    The name of the Container Apps Managed Environment. Changing this forces a new resource to be created.
    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
    The name of the resource group in which the Container App Environment is to be created. Changing this forces a new resource to be created.
    staticIpAddress string
    The Static IP address of the Environment.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    workloadProfiles EnvironmentWorkloadProfile[]
    The profile of the workload to scope the container app execution. A workload_profile block as defined below.
    zoneRedundancyEnabled boolean

    Should the Container App Environment be created with Zone Redundancy enabled? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    dapr_application_insights_connection_string str
    Application Insights connection string used by Dapr to export Service to Service communication telemetry. Changing this forces a new resource to be created.
    default_domain str
    The default, publicly resolvable, name of this Container App Environment.
    docker_bridge_cidr str
    The network addressing in which the Container Apps in this Container App Environment will reside in CIDR notation.
    infrastructure_resource_group_name str

    Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. Changing this forces a new resource to be created.

    Note: Only valid if a workload_profile is specified. If infrastructure_subnet_id is specified, this resource group will be created in the same subscription as infrastructure_subnet_id.

    infrastructure_subnet_id str

    The existing Subnet to use for the Container Apps Control Plane. Changing this forces a new resource to be created.

    NOTE: The Subnet must have a /21 or larger address space.

    internal_load_balancer_enabled bool

    Should the Container Environment operate in Internal Load Balancing Mode? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    location str
    Specifies the supported Azure location where the Container App Environment is to exist. Changing this forces a new resource to be created.
    log_analytics_workspace_id str
    The ID for the Log Analytics Workspace to link this Container Apps Managed Environment to. Changing this forces a new resource to be created.
    name str
    The name of the Container Apps Managed Environment. Changing this forces a new resource to be created.
    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
    The name of the resource group in which the Container App Environment is to be created. Changing this forces a new resource to be created.
    static_ip_address str
    The Static IP address of the Environment.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    workload_profiles Sequence[EnvironmentWorkloadProfileArgs]
    The profile of the workload to scope the container app execution. A workload_profile block as defined below.
    zone_redundancy_enabled bool

    Should the Container App Environment be created with Zone Redundancy enabled? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    daprApplicationInsightsConnectionString String
    Application Insights connection string used by Dapr to export Service to Service communication telemetry. Changing this forces a new resource to be created.
    defaultDomain String
    The default, publicly resolvable, name of this Container App Environment.
    dockerBridgeCidr String
    The network addressing in which the Container Apps in this Container App Environment will reside in CIDR notation.
    infrastructureResourceGroupName String

    Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. Changing this forces a new resource to be created.

    Note: Only valid if a workload_profile is specified. If infrastructure_subnet_id is specified, this resource group will be created in the same subscription as infrastructure_subnet_id.

    infrastructureSubnetId String

    The existing Subnet to use for the Container Apps Control Plane. Changing this forces a new resource to be created.

    NOTE: The Subnet must have a /21 or larger address space.

    internalLoadBalancerEnabled Boolean

    Should the Container Environment operate in Internal Load Balancing Mode? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    location String
    Specifies the supported Azure location where the Container App Environment is to exist. Changing this forces a new resource to be created.
    logAnalyticsWorkspaceId String
    The ID for the Log Analytics Workspace to link this Container Apps Managed Environment to. Changing this forces a new resource to be created.
    name String
    The name of the Container Apps Managed Environment. Changing this forces a new resource to be created.
    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
    The name of the resource group in which the Container App Environment is to be created. Changing this forces a new resource to be created.
    staticIpAddress String
    The Static IP address of the Environment.
    tags Map<String>
    A mapping of tags to assign to the resource.
    workloadProfiles List<Property Map>
    The profile of the workload to scope the container app execution. A workload_profile block as defined below.
    zoneRedundancyEnabled Boolean

    Should the Container App Environment be created with Zone Redundancy enabled? Defaults to false. Changing this forces a new resource to be created.

    Note: can only be set to true if infrastructure_subnet_id is specified.

    Supporting Types

    EnvironmentWorkloadProfile, EnvironmentWorkloadProfileArgs

    Name string
    The name of the workload profile.
    WorkloadProfileType string

    Workload profile type for the workloads to run on. Possible values include Consumption, D4, D8, D16, D32, E4, E8, E16 and E32.

    NOTE: A Consumption type must have a name of Consumption and an environment may only have one Consumption Workload Profile.

    NOTE: Defining a Consumption profile is optional, however, Environments created without an initial Workload Profile cannot have them added at a later time and must be recreated. Similarly, an environment created with Profiles must always have at least one defined Profile, removing all profiles will force a recreation of the resource.

    MaximumCount int
    The maximum number of instances of workload profile that can be deployed in the Container App Environment.
    MinimumCount int
    The minimum number of instances of workload profile that can be deployed in the Container App Environment.
    Name string
    The name of the workload profile.
    WorkloadProfileType string

    Workload profile type for the workloads to run on. Possible values include Consumption, D4, D8, D16, D32, E4, E8, E16 and E32.

    NOTE: A Consumption type must have a name of Consumption and an environment may only have one Consumption Workload Profile.

    NOTE: Defining a Consumption profile is optional, however, Environments created without an initial Workload Profile cannot have them added at a later time and must be recreated. Similarly, an environment created with Profiles must always have at least one defined Profile, removing all profiles will force a recreation of the resource.

    MaximumCount int
    The maximum number of instances of workload profile that can be deployed in the Container App Environment.
    MinimumCount int
    The minimum number of instances of workload profile that can be deployed in the Container App Environment.
    name String
    The name of the workload profile.
    workloadProfileType String

    Workload profile type for the workloads to run on. Possible values include Consumption, D4, D8, D16, D32, E4, E8, E16 and E32.

    NOTE: A Consumption type must have a name of Consumption and an environment may only have one Consumption Workload Profile.

    NOTE: Defining a Consumption profile is optional, however, Environments created without an initial Workload Profile cannot have them added at a later time and must be recreated. Similarly, an environment created with Profiles must always have at least one defined Profile, removing all profiles will force a recreation of the resource.

    maximumCount Integer
    The maximum number of instances of workload profile that can be deployed in the Container App Environment.
    minimumCount Integer
    The minimum number of instances of workload profile that can be deployed in the Container App Environment.
    name string
    The name of the workload profile.
    workloadProfileType string

    Workload profile type for the workloads to run on. Possible values include Consumption, D4, D8, D16, D32, E4, E8, E16 and E32.

    NOTE: A Consumption type must have a name of Consumption and an environment may only have one Consumption Workload Profile.

    NOTE: Defining a Consumption profile is optional, however, Environments created without an initial Workload Profile cannot have them added at a later time and must be recreated. Similarly, an environment created with Profiles must always have at least one defined Profile, removing all profiles will force a recreation of the resource.

    maximumCount number
    The maximum number of instances of workload profile that can be deployed in the Container App Environment.
    minimumCount number
    The minimum number of instances of workload profile that can be deployed in the Container App Environment.
    name str
    The name of the workload profile.
    workload_profile_type str

    Workload profile type for the workloads to run on. Possible values include Consumption, D4, D8, D16, D32, E4, E8, E16 and E32.

    NOTE: A Consumption type must have a name of Consumption and an environment may only have one Consumption Workload Profile.

    NOTE: Defining a Consumption profile is optional, however, Environments created without an initial Workload Profile cannot have them added at a later time and must be recreated. Similarly, an environment created with Profiles must always have at least one defined Profile, removing all profiles will force a recreation of the resource.

    maximum_count int
    The maximum number of instances of workload profile that can be deployed in the Container App Environment.
    minimum_count int
    The minimum number of instances of workload profile that can be deployed in the Container App Environment.
    name String
    The name of the workload profile.
    workloadProfileType String

    Workload profile type for the workloads to run on. Possible values include Consumption, D4, D8, D16, D32, E4, E8, E16 and E32.

    NOTE: A Consumption type must have a name of Consumption and an environment may only have one Consumption Workload Profile.

    NOTE: Defining a Consumption profile is optional, however, Environments created without an initial Workload Profile cannot have them added at a later time and must be recreated. Similarly, an environment created with Profiles must always have at least one defined Profile, removing all profiles will force a recreation of the resource.

    maximumCount Number
    The maximum number of instances of workload profile that can be deployed in the Container App Environment.
    minimumCount Number
    The minimum number of instances of workload profile that can be deployed in the Container App Environment.

    Import

    A Container App Environment can be imported using the resource id, e.g.

    $ pulumi import azure:containerapp/environment:Environment example "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resGroup1/providers/Microsoft.App/managedEnvironments/myEnvironment"

    To learn more about importing existing cloud resources, see Importing resources.

    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 Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-azure