Managed Environments - Get

Service:

Azure Container Apps

API Version:

2024-03-01

Get the properties of a Managed Environment used to host container apps.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}?api-version=2024-03-01

URI Parameters

Name	In	Required	Type	Description
environmentName	path	True	string	Name of the Environment.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ManagedEnvironment	OK
Other Status Codes	DefaultErrorResponse	Common error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get environments by name

Sample Request

HTTP

GET https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1?api-version=2024-03-01

Sample Response

Status code:

200

{
  "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1",
  "name": "jlaw-demo1",
  "type": "Microsoft.App/managedEnvironments",
  "location": "North Central US",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "deploymentErrors": null,
    "defaultDomain": "jlaw-demo1.k4apps.io",
    "staticIp": "20.42.33.145",
    "zoneRedundant": true,
    "vnetConfiguration": {
      "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1"
    },
    "customDomainConfiguration": {
      "customDomainVerificationId": "custom domain verification id",
      "dnsSuffix": "www.my-name.com",
      "subjectName": "CN=www.my-name.com",
      "expirationDate": "2022-11-06T04:00:00Z",
      "thumbprint": "CERTIFICATE_THUMBPRINT"
    },
    "eventStreamEndpoint": "testEndpoint",
    "workloadProfiles": [
      {
        "name": "My-GP-01",
        "workloadProfileType": "GeneralPurpose",
        "minimumCount": 3,
        "maximumCount": 12
      },
      {
        "name": "My-MO-01",
        "workloadProfileType": "MemoryOptimized",
        "minimumCount": 3,
        "maximumCount": 6
      },
      {
        "name": "My-CO-01",
        "workloadProfileType": "ComputeOptimized",
        "minimumCount": 3,
        "maximumCount": 6
      },
      {
        "name": "My-consumption-01",
        "workloadProfileType": "Consumption"
      }
    ],
    "kedaConfiguration": {
      "version": "2.8.1"
    },
    "daprConfiguration": {
      "version": "1.9"
    },
    "infrastructureResourceGroup": "capp-svc-jlaw-demo1-northcentralus",
    "peerAuthentication": {
      "mtls": {
        "enabled": true
      }
    },
    "peerTrafficConfiguration": {
      "encryption": {
        "enabled": true
      }
    }
  }
}

Definitions

Name	Description
AppLogsConfiguration	Configuration of application logs
createdByType	The type of identity that created the resource.
CustomDomainConfiguration	Configuration properties for apps environment custom domain
DaprConfiguration	Configuration properties Dapr component
DefaultErrorResponse	App Service error response.
Details	Details or the error
Encryption	Peer traffic encryption settings for the Managed Environment
EnvironmentProvisioningState	Provisioning state of the Environment.
Error	Error model.
KedaConfiguration	Configuration properties Keda component
LogAnalyticsConfiguration	Log Analytics configuration, must only be provided when destination is configured as 'log-analytics'
ManagedEnvironment	An environment for hosting container apps
Mtls	Configuration properties for mutual TLS authentication
PeerAuthentication	Peer authentication settings for the Managed Environment
PeerTrafficConfiguration	Peer traffic settings for the Managed Environment
systemData	Metadata pertaining to creation and last modification of the resource.
VnetConfiguration	Configuration properties for apps environment to join a Virtual Network
WorkloadProfile	Workload profile to scope container app execution.

AppLogsConfiguration

Configuration of application logs

Name	Type	Description
destination	string	Logs destination, can be 'log-analytics', 'azure-monitor' or 'none'
logAnalyticsConfiguration	LogAnalyticsConfiguration	Log Analytics configuration, must only be provided when destination is configured as 'log-analytics'

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CustomDomainConfiguration

Configuration properties for apps environment custom domain

Name	Type	Description
certificatePassword	string	Certificate password
certificateValue	string	PFX or PEM blob
customDomainVerificationId	string	Id used to verify domain name ownership
dnsSuffix	string	Dns suffix for the environment domain
expirationDate	string	Certificate expiration date.
subjectName	string	Subject name of the certificate.
thumbprint	string	Certificate thumbprint.

DaprConfiguration

Configuration properties Dapr component

Name	Type	Description
version	string	The version of Dapr

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Details or the error

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Encryption

Peer traffic encryption settings for the Managed Environment

Name	Type	Description
enabled	boolean	Boolean indicating whether the peer traffic encryption is enabled

EnvironmentProvisioningState

Provisioning state of the Environment.

Name	Type	Description
Canceled	string
Failed	string
InfrastructureSetupComplete	string
InfrastructureSetupInProgress	string
InitializationInProgress	string
ScheduledForDelete	string
Succeeded	string
UpgradeFailed	string
UpgradeRequested	string
Waiting	string

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Details or the error
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

KedaConfiguration

Configuration properties Keda component

Name	Type	Description
version	string	The version of Keda

LogAnalyticsConfiguration

Log Analytics configuration, must only be provided when destination is configured as 'log-analytics'

Name	Type	Description
customerId	string	Log analytics customer id
sharedKey	string	Log analytics customer key

ManagedEnvironment

An environment for hosting container apps

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string	Kind of the Environment.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.appLogsConfiguration	AppLogsConfiguration	Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported
properties.customDomainConfiguration	CustomDomainConfiguration	Custom domain configuration for the environment
properties.daprAIConnectionString	string	Application Insights connection string used by Dapr to export Service to Service communication telemetry
properties.daprAIInstrumentationKey	string	Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry
properties.daprConfiguration	DaprConfiguration	The configuration of Dapr component.
properties.defaultDomain	string	Default Domain Name for the cluster
properties.deploymentErrors	string	Any errors that occurred during deployment or deployment validation
properties.eventStreamEndpoint	string	The endpoint of the eventstream of the Environment.
properties.infrastructureResourceGroup	string	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.
properties.kedaConfiguration	KedaConfiguration	The configuration of Keda component.
properties.peerAuthentication	PeerAuthentication	Peer authentication settings for the Managed Environment
properties.peerTrafficConfiguration	PeerTrafficConfiguration	Peer traffic settings for the Managed Environment
properties.provisioningState	EnvironmentProvisioningState	Provisioning state of the Environment.
properties.staticIp	string	Static IP of the Environment
properties.vnetConfiguration	VnetConfiguration	Vnet configuration for the environment
properties.workloadProfiles	WorkloadProfile[]	Workload profiles configured for the Managed Environment.
properties.zoneRedundant	boolean	Whether or not this Managed Environment is zone-redundant.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Mtls

Configuration properties for mutual TLS authentication

Name	Type	Description
enabled	boolean	Boolean indicating whether the mutual TLS authentication is enabled

PeerAuthentication

Peer authentication settings for the Managed Environment

Name	Type	Description
mtls	Mtls	Mutual TLS authentication settings for the Managed Environment

PeerTrafficConfiguration

Peer traffic settings for the Managed Environment

Name	Type	Description
encryption	Encryption	Peer traffic encryption settings for the Managed Environment

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

VnetConfiguration

Configuration properties for apps environment to join a Virtual Network

Name	Type	Description
dockerBridgeCidr	string	CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges.
infrastructureSubnetId	string	Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges.
internal	boolean	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
platformReservedCidr	string	IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges.
platformReservedDnsIP	string	An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server.

WorkloadProfile

Workload profile to scope container app execution.

Name	Type	Description
maximumCount	integer	The maximum capacity.
minimumCount	integer	The minimum capacity.
name	string	Workload profile type for the workloads to run on.
workloadProfileType	string	Workload profile type for the workloads to run on.