New-AzContainerAppManagedEnv

Module:

Az.App

Create a Managed Environment used to host container apps.

Syntax

New-AzContainerAppManagedEnv
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -Location <String>
   [-AppLogConfigurationDestination <String>]
   [-CustomDomainConfigurationCertificateValueInputFile <String>]
   [-CustomDomainConfigurationDnsSuffix <String>]
   [-CustomDomainPassword <SecureString>]
   [-DaprAiConnectionString <String>]
   [-DaprAiInstrumentationKey <String>]
   [-InfrastructureResourceGroup <String>]
   [-Kind <String>]
   [-LogAnalyticConfigurationCustomerId <String>]
   [-LogAnalyticConfigurationSharedKey <String>]
   [-MtlEnabled]
   [-Tag <Hashtable>]
   [-VnetConfigurationDockerBridgeCidr <String>]
   [-VnetConfigurationInfrastructureSubnetId <String>]
   [-VnetConfigurationInternal]
   [-VnetConfigurationPlatformReservedCidr <String>]
   [-VnetConfigurationPlatformReservedDnsIP <String>]
   [-WorkloadProfile <IWorkloadProfile[]>]
   [-ZoneRedundant]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzContainerAppManagedEnv
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -JsonString <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzContainerAppManagedEnv
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -JsonFilePath <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzContainerAppManagedEnv
   -InputObject <IAppIdentity>
   -Location <String>
   [-AppLogConfigurationDestination <String>]
   [-CustomDomainConfigurationCertificateValueInputFile <String>]
   [-CustomDomainConfigurationDnsSuffix <String>]
   [-CustomDomainPassword <SecureString>]
   [-DaprAiConnectionString <String>]
   [-DaprAiInstrumentationKey <String>]
   [-InfrastructureResourceGroup <String>]
   [-Kind <String>]
   [-LogAnalyticConfigurationCustomerId <String>]
   [-LogAnalyticConfigurationSharedKey <String>]
   [-MtlEnabled]
   [-Tag <Hashtable>]
   [-VnetConfigurationDockerBridgeCidr <String>]
   [-VnetConfigurationInfrastructureSubnetId <String>]
   [-VnetConfigurationInternal]
   [-VnetConfigurationPlatformReservedCidr <String>]
   [-VnetConfigurationPlatformReservedDnsIP <String>]
   [-WorkloadProfile <IWorkloadProfile[]>]
   [-ZoneRedundant]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Create a Managed Environment used to host container apps.

Examples

Example 1: Create a Managed Environment used to host container apps.

New-AzOperationalInsightsWorkspace -ResourceGroupName azps_test_group_app -Name workspace-azpstestgp -Sku PerGB2018 -Location canadacentral -PublicNetworkAccessForIngestion "Enabled" -PublicNetworkAccessForQuery "Enabled"

$CustomId = (Get-AzOperationalInsightsWorkspace -ResourceGroupName azps_test_group_app -Name workspace-azpstestgp).CustomerId
$SharedKey = (Get-AzOperationalInsightsWorkspaceSharedKey -ResourceGroupName azps_test_group_app -Name workspace-azpstestgp).PrimarySharedKey
$workloadProfile = New-AzContainerAppWorkloadProfileObject -Name "Consumption" -Type "Consumption"

New-AzContainerAppManagedEnv -Name azps-env -ResourceGroupName azps_test_group_app -Location eastus -AppLogConfigurationDestination "log-analytics" -LogAnalyticConfigurationCustomerId $CustomId -LogAnalyticConfigurationSharedKey $SharedKey -VnetConfigurationInternal:$false -WorkloadProfile $workloadProfile

Location Name    ResourceGroupName
-------- ----    -----------------
East US  azps-env azps_test_group_app

Create a Managed Environment used to host container apps.

Parameters

-AppLogConfigurationDestination

Logs destination, can be 'log-analytics', 'azure-monitor' or 'none'

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AsJob

Run the command as a job

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomDomainConfigurationCertificateValueInputFile

Input File for CustomDomainConfigurationCertificateValue (PFX or PEM blob)

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomDomainConfigurationDnsSuffix

Dns suffix for the environment domain

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomDomainPassword

Certificate password.

Type:	SecureString
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DaprAiConnectionString

Application Insights connection string used by Dapr to export Service to Service communication telemetry

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DaprAiInstrumentationKey

Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InfrastructureResourceGroup

Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	IAppIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-JsonFilePath

Path of Json file supplied to the Create operation

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-JsonString

Json string supplied to the Create operation

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Kind

Kind of the Environment.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Location

The geo-location where the resource lives

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-LogAnalyticConfigurationCustomerId

Log analytics customer id

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LogAnalyticConfigurationSharedKey

Log analytics customer key

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MtlEnabled

Boolean indicating whether the mutual TLS authentication is enabled

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Name of the Environment.

Type:	String
Aliases:	EnvName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NoWait

Run the command asynchronously

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

The ID of the target subscription.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tag

Resource tags.

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VnetConfigurationDockerBridgeCidr

CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VnetConfigurationInfrastructureSubnetId

Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VnetConfigurationInternal

Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VnetConfigurationPlatformReservedCidr

IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VnetConfigurationPlatformReservedDnsIP

An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WorkloadProfile

Workload profiles configured for the Managed Environment. To construct, see NOTES section for WORKLOADPROFILE properties and create a hash table.

Type:	IWorkloadProfile[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ZoneRedundant

Whether or not this Managed Environment is zone-redundant.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IAppIdentity

Outputs

IManagedEnvironment