PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/?api-version=2023-08-01-preview
Creates or updates a Managed Environment used to host container apps.
Servers
- https://management.azure.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
subscriptionId |
String | Yes |
The ID of the target subscription. The value must be an UUID. |
environmentName |
String | Yes |
Name of the Environment. |
resourceGroupName |
String | Yes |
The name of the resource group. The name is case insensitive. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
location |
String | No |
The geo-location where the resource lives |
properties |
Object | No |
Managed environment resource specific properties |
properties.appInsightsConfiguration |
Object | No |
Configuration of Application Insights |
properties.appInsightsConfiguration.connectionString |
String | No |
Application Insights connection string |
properties.infrastructureResourceGroup |
String | No |
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.appLogsConfiguration |
Object | No |
Configuration of application logs |
properties.appLogsConfiguration.destination |
String | No |
Logs destination, can be 'log-analytics', 'azure-monitor' or 'none' |
properties.appLogsConfiguration.logAnalyticsConfiguration |
Object | No |
Log Analytics configuration, must only be provided when destination is configured as 'log-analytics' |
properties.appLogsConfiguration.logAnalyticsConfiguration.sharedKey |
String | No |
Log analytics customer key |
properties.appLogsConfiguration.logAnalyticsConfiguration.dynamicJsonColumns |
Boolean | No |
Boolean indicating whether to parse json string log into dynamic json columns |
properties.appLogsConfiguration.logAnalyticsConfiguration.customerId |
String | No |
Log analytics customer id |
properties.openTelemetryConfiguration |
Object | No |
Configuration of Open Telemetry |
properties.openTelemetryConfiguration.destinationsConfiguration |
Object | No |
Configuration of Open Telemetry destinations |
properties.openTelemetryConfiguration.destinationsConfiguration.dataDogConfiguration |
Object | No |
Configuration of datadog |
properties.openTelemetryConfiguration.destinationsConfiguration.dataDogConfiguration.key |
String | No |
The data dog api key |
properties.openTelemetryConfiguration.destinationsConfiguration.dataDogConfiguration.site |
String | No |
The data dog site |
properties.openTelemetryConfiguration.logsConfiguration |
Object | No |
Configuration of Open Telemetry logs |
properties.openTelemetryConfiguration.logsConfiguration.destinations[] |
Array | No |
Open telemetry logs destinations |
properties.openTelemetryConfiguration.metricsConfiguration |
Object | No |
Configuration of Open Telemetry metrics |
properties.openTelemetryConfiguration.metricsConfiguration.destinations[] |
Array | No |
Open telemetry metrics destinations |
properties.openTelemetryConfiguration.tracesConfiguration |
Object | No |
Configuration of Open Telemetry traces |
properties.openTelemetryConfiguration.tracesConfiguration.destinations[] |
Array | No |
Open telemetry traces destinations |
properties.daprAIConnectionString |
String | No |
Application Insights connection string used by Dapr to export Service to Service communication telemetry |
properties.peerAuthentication |
Object | No |
Peer authentication settings for the Managed Environment |
properties.peerAuthentication.mtls |
Object | No |
Configuration properties for mutual TLS authentication |
properties.peerAuthentication.mtls.enabled |
Boolean | No |
Boolean indicating whether the mutual TLS authentication is enabled |
properties.deploymentErrors |
String | No |
Any errors that occurred during deployment or deployment validation |
properties.kedaConfiguration |
Object | No |
Configuration properties Keda component |
properties.kedaConfiguration.version |
String | No |
The version of Keda |
properties.customDomainConfiguration |
Object | No |
Configuration properties for apps environment custom domain |
properties.customDomainConfiguration.expirationDate |
String | No |
Certificate expiration date. |
properties.customDomainConfiguration.dnsSuffix |
String | No |
Dns suffix for the environment domain |
properties.customDomainConfiguration.thumbprint |
String | No |
Certificate thumbprint. |
properties.customDomainConfiguration.subjectName |
String | No |
Subject name of the certificate. |
properties.customDomainConfiguration.certificatePassword |
String | No |
Certificate password |
properties.customDomainConfiguration.certificateValue |
String | No |
PFX or PEM blob |
properties.customDomainConfiguration.customDomainVerificationId |
String | No |
Id used to verify domain name ownership |
properties.eventStreamEndpoint |
String | No |
The endpoint of the eventstream of the Environment. |
properties.defaultDomain |
String | No |
Default Domain Name for the cluster |
properties.provisioningState |
String | No |
Provisioning state of the Environment. Possible values:
|
properties.workloadProfiles[] |
Array | No |
Workload profiles configured for the Managed Environment. |
properties.workloadProfiles[].name |
String | Yes |
Workload profile name for container apps to execute on. |
properties.workloadProfiles[].maximumCount |
Integer | No |
The maximum capacity. |
properties.workloadProfiles[].workloadProfileType |
String | Yes |
Workload profile type for container apps to execute on. |
properties.workloadProfiles[].minimumCount |
Integer | No |
The minimum capacity. |
properties.vnetConfiguration |
Object | No |
Configuration properties for apps environment to join a Virtual Network |
properties.vnetConfiguration.infrastructureSubnetId |
String | No |
Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges. |
properties.vnetConfiguration.platformReservedCidr |
String | No |
IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges. |
properties.vnetConfiguration.dockerBridgeCidr |
String | No |
CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges. |
properties.vnetConfiguration.platformReservedDnsIP |
String | No |
An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. |
properties.vnetConfiguration.internal |
Boolean | No |
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 |
properties.daprConfiguration |
Object | No |
Configuration properties Dapr component |
properties.daprConfiguration.version |
String | No |
The version of Dapr |
properties.staticIp |
String | No |
Static IP of the Environment |
properties.zoneRedundant |
Boolean | No |
Whether or not this Managed Environment is zone-redundant. |
properties.daprAIInstrumentationKey |
String | No |
Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry |
tags |
Object | No |
Resource tags. |
kind |
String | No |
Kind of the Environment. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.