Container Apps - Create Or Update
Create or update a Container App.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}?api-version=2024-03-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
container
|
path | True |
string |
Name of the Container App. |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
subscription
|
path | True |
string |
The ID of the target subscription. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
location | True |
string |
The geo-location where the resource lives |
extendedLocation |
The complex type of the extended location. |
||
identity |
managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. |
||
managedBy |
string |
The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource. |
|
properties.configuration |
Non versioned Container App configuration properties. |
||
properties.environmentId |
string |
Resource ID of environment. |
|
properties.managedEnvironmentId |
string |
Deprecated. Resource ID of the Container App's environment. |
|
properties.template |
Container App versioned application definition. |
||
properties.workloadProfileName |
string |
Workload profile name to pin for container app execution. |
|
tags |
object |
Resource tags. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
No change performed on the Container App. |
|
201 Created |
Container App create or update has been started. |
|
Other Status Codes |
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
Create or Update Container App |
Create or Update Managed |
Create or Update Tcp App |
Create or Update Container App
Sample request
PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0?api-version=2024-03-01
{
"location": "East US",
"properties": {
"environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube",
"workloadProfileName": "My-GP-01",
"configuration": {
"ingress": {
"external": true,
"targetPort": 3000,
"customDomains": [
{
"name": "www.my-name.com",
"bindingType": "SniEnabled",
"certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com"
},
{
"name": "www.my-other-name.com",
"bindingType": "SniEnabled",
"certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com"
}
],
"traffic": [
{
"weight": 100,
"revisionName": "testcontainerapp0-ab1234",
"label": "production"
}
],
"ipSecurityRestrictions": [
{
"name": "Allow work IP A subnet",
"description": "Allowing all IP's within the subnet below to access containerapp",
"ipAddressRange": "192.168.1.1/32",
"action": "Allow"
},
{
"name": "Allow work IP B subnet",
"description": "Allowing all IP's within the subnet below to access containerapp",
"ipAddressRange": "192.168.1.1/8",
"action": "Allow"
}
],
"stickySessions": {
"affinity": "sticky"
},
"clientCertificateMode": "accept",
"corsPolicy": {
"allowedOrigins": [
"https://a.test.com",
"https://b.test.com"
],
"allowedMethods": [
"GET",
"POST"
],
"allowedHeaders": [
"HEADER1",
"HEADER2"
],
"exposeHeaders": [
"HEADER3",
"HEADER4"
],
"maxAge": 1234,
"allowCredentials": true
},
"additionalPortMappings": [
{
"external": true,
"targetPort": 1234
},
{
"external": false,
"targetPort": 2345,
"exposedPort": 3456
}
]
},
"dapr": {
"enabled": true,
"appPort": 3000,
"appProtocol": "http",
"httpReadBufferSize": 30,
"httpMaxRequestSize": 10,
"logLevel": "debug",
"enableApiLogging": true
},
"maxInactiveRevisions": 10,
"service": {
"type": "redis"
}
},
"template": {
"containers": [
{
"image": "repo/testcontainerapp0:v1",
"name": "testcontainerapp0",
"probes": [
{
"type": "Liveness",
"httpGet": {
"path": "/health",
"port": 8080,
"httpHeaders": [
{
"name": "Custom-Header",
"value": "Awesome"
}
]
},
"initialDelaySeconds": 3,
"periodSeconds": 3
}
]
}
],
"initContainers": [
{
"image": "repo/testcontainerapp0:v4",
"name": "testinitcontainerApp0",
"resources": {
"cpu": 0.5,
"memory": "1Gi"
},
"command": [
"/bin/sh"
],
"args": [
"-c",
"while true; do echo hello; sleep 10;done"
]
}
],
"scale": {
"minReplicas": 1,
"maxReplicas": 5,
"rules": [
{
"name": "httpscalingrule",
"custom": {
"type": "http",
"metadata": {
"concurrentRequests": "50"
}
}
}
]
},
"serviceBinds": [
{
"serviceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/redisService",
"name": "redisService"
}
]
}
}
}
Sample response
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0",
"name": "testcontainerapp0",
"type": "Microsoft.App/containerApps",
"location": "East US",
"properties": {
"provisioningState": "Succeeded",
"managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube",
"workloadProfileName": "My-GP-01",
"latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io",
"latestReadyRevisionName": "testcontainerapp0-pjxhsye",
"configuration": {
"ingress": {
"fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io",
"external": true,
"targetPort": 3000,
"transport": "auto",
"customDomains": [
{
"name": "www.my-name.com",
"bindingType": "SniEnabled",
"certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com"
},
{
"name": "www.my-other-name.com",
"bindingType": "SniEnabled",
"certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com"
}
],
"traffic": [
{
"weight": 80,
"revisionName": "testcontainerapp0-ab1234"
},
{
"weight": 20,
"revisionName": "testcontainerapp0-ab4321",
"label": "staging"
}
],
"ipSecurityRestrictions": [
{
"name": "Allow work IP A subnet",
"description": "Allowing all IP's within the subnet below to access containerapp",
"ipAddressRange": "192.168.1.1/32",
"action": "Allow"
},
{
"name": "Allow work IP B subnet",
"description": "Allowing all IP's within the subnet below to access containerapp",
"ipAddressRange": "192.168.1.1/8",
"action": "Allow"
}
],
"stickySessions": {
"affinity": "sticky"
}
},
"dapr": {
"enabled": true,
"appPort": 3000,
"appProtocol": "http",
"httpReadBufferSize": 30
}
},
"template": {
"containers": [
{
"image": "repo/testcontainerapp0:v4",
"name": "testcontainerapp0",
"resources": {
"cpu": 0.5,
"memory": "1Gi"
},
"probes": [
{
"type": "Liveness",
"httpGet": {
"path": "/health",
"port": 8080,
"httpHeaders": [
{
"name": "Custom-Header",
"value": "Awesome"
}
]
},
"initialDelaySeconds": 3,
"periodSeconds": 3
}
]
}
],
"initContainers": [
{
"image": "repo/testcontainerapp0:v4",
"name": "testinitcontainerApp0",
"resources": {
"cpu": 0.5,
"memory": "1Gi"
},
"command": [
"/bin/sh"
],
"args": [
"-c",
"while true; do echo hello; sleep 10;done"
]
}
],
"scale": {
"minReplicas": 1,
"maxReplicas": 5,
"rules": [
{
"name": "httpscalingrule",
"http": {
"metadata": {
"concurrentRequests": "50"
}
}
}
]
}
},
"eventStreamEndpoint": "testEndpoint"
}
}
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0",
"name": "testcontainerapp0",
"type": "Microsoft.App/containerApps",
"location": "East US",
"properties": {
"provisioningState": "InProgress",
"managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube",
"latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io",
"configuration": {
"ingress": {
"fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io",
"external": true,
"targetPort": 3000,
"transport": "auto",
"traffic": [
{
"weight": 80,
"revisionName": "testcontainerapp0-ab1234"
},
{
"weight": 20,
"revisionName": "testcontainerapp0-ab4321",
"label": "staging"
}
]
},
"dapr": {
"enabled": true,
"appPort": 3000,
"appProtocol": "http",
"httpReadBufferSize": 30
}
},
"template": {
"containers": [
{
"image": "repo/testcontainerapp0:v4",
"name": "testcontainerapp0",
"resources": {
"cpu": 0.5,
"memory": "1Gi"
},
"probes": [
{
"type": "Liveness",
"httpGet": {
"path": "/health",
"port": 8080,
"httpHeaders": [
{
"name": "Custom-Header",
"value": "Awesome"
}
]
},
"initialDelaySeconds": 3,
"periodSeconds": 3
}
]
}
],
"initContainers": [
{
"image": "repo/testcontainerapp0:v4",
"name": "testinitcontainerApp0",
"resources": {
"cpu": 0.5,
"memory": "1Gi"
},
"command": [
"/bin/sh"
],
"args": [
"-c",
"while true; do echo hello; sleep 10;done"
]
}
],
"scale": {
"minReplicas": 1,
"maxReplicas": 5,
"rules": [
{
"name": "httpscalingrule",
"http": {
"metadata": {
"concurrentRequests": "50"
}
}
}
]
}
},
"eventStreamEndpoint": "testEndpoint"
}
}
Create or Update ManagedBy App
Sample request
PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerappmanagedby?api-version=2024-03-01
{
"location": "East US",
"managedBy": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp",
"properties": {
"environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube",
"configuration": {
"ingress": {
"external": true,
"targetPort": 3000,
"exposedPort": 4000,
"transport": "tcp",
"traffic": [
{
"weight": 100,
"revisionName": "testcontainerappmanagedby-ab1234"
}
]
}
},
"template": {
"containers": [
{
"image": "repo/testcontainerappmanagedby:v1",
"name": "testcontainerappmanagedby",
"probes": [
{
"type": "Liveness",
"tcpSocket": {
"port": 8080
},
"initialDelaySeconds": 3,
"periodSeconds": 3
}
]
}
],
"scale": {
"minReplicas": 1,
"maxReplicas": 5,
"rules": [
{
"name": "tcpscalingrule",
"tcp": {
"metadata": {
"concurrentConnections": "50"
}
}
}
]
}
}
}
}
Sample response
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerappmanagedby",
"name": "testcontainerappmanagedby",
"type": "Microsoft.App/containerApps",
"location": "East US",
"managedBy": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp",
"properties": {
"provisioningState": "Succeeded",
"managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube",
"latestRevisionFqdn": "testcontainerappmanagedby-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io",
"latestReadyRevisionName": "testcontainerappmanagedby-pjxhsye",
"configuration": {
"ingress": {
"fqdn": "testcontainerappmanagedby.demokube-t24clv0g.eastus.containerApps.k4apps.io",
"external": true,
"targetPort": 3000,
"exposedPort": 4000,
"transport": "tcp",
"traffic": [
{
"weight": 80,
"revisionName": "testcontainerappmanagedby-ab1234"
},
{
"weight": 20,
"revisionName": "testcontainerappmanagedby-ab4321"
}
]
}
},
"template": {
"containers": [
{
"image": "repo/testcontainerappmanagedby:v4",
"name": "testcontainerappmanagedby",
"resources": {
"cpu": 0.5,
"memory": "1Gi"
},
"probes": [
{
"type": "Liveness",
"tcpSocket": {
"port": 8080
},
"initialDelaySeconds": 3,
"periodSeconds": 3
}
]
}
],
"scale": {
"minReplicas": 1,
"maxReplicas": 5,
"rules": [
{
"name": "tcpscalingrule",
"tcp": {
"metadata": {
"concurrentConnections": "50"
}
}
}
]
}
}
}
}
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerappmanagedby",
"name": "testcontainerappmanagedby",
"type": "Microsoft.App/containerApps",
"location": "East US",
"managedBy": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp",
"properties": {
"provisioningState": "InProgress",
"managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube",
"latestRevisionFqdn": "testcontainerappmanagedby-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io",
"configuration": {
"ingress": {
"fqdn": "testcontainerappmanagedby.demokube-t24clv0g.eastus.containerApps.k4apps.io",
"external": true,
"targetPort": 3000,
"exposedPort": 4000,
"transport": "tcp",
"traffic": [
{
"weight": 80,
"revisionName": "testcontainerappmanagedby-ab1234"
},
{
"weight": 20,
"revisionName": "testcontainerappmanagedby-ab4321"
}
]
}
},
"template": {
"containers": [
{
"image": "repo/testcontainerappmanagedby:v4",
"name": "testcontainerappmanagedby",
"resources": {
"cpu": 0.5,
"memory": "1Gi"
},
"probes": [
{
"type": "Liveness",
"tcpSocket": {
"port": 8080
},
"initialDelaySeconds": 3,
"periodSeconds": 3
}
]
}
],
"scale": {
"minReplicas": 1,
"maxReplicas": 5,
"rules": [
{
"name": "tcpscalingrule",
"tcp": {
"metadata": {
"concurrentConnections": "50"
}
}
}
]
}
}
}
}
Create or Update Tcp App
Sample request
PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapptcp?api-version=2024-03-01
{
"location": "East US",
"properties": {
"environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube",
"configuration": {
"ingress": {
"external": true,
"targetPort": 3000,
"exposedPort": 4000,
"transport": "tcp",
"traffic": [
{
"weight": 100,
"revisionName": "testcontainerapptcp-ab1234"
}
]
}
},
"template": {
"containers": [
{
"image": "repo/testcontainerapptcp:v1",
"name": "testcontainerapptcp",
"probes": [
{
"type": "Liveness",
"tcpSocket": {
"port": 8080
},
"initialDelaySeconds": 3,
"periodSeconds": 3
}
]
}
],
"scale": {
"minReplicas": 1,
"maxReplicas": 5,
"rules": [
{
"name": "tcpscalingrule",
"tcp": {
"metadata": {
"concurrentConnections": "50"
}
}
}
]
}
}
}
}
Sample response
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapptcp",
"name": "testcontainerapptcp",
"type": "Microsoft.App/containerApps",
"location": "East US",
"properties": {
"provisioningState": "Succeeded",
"managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube",
"latestRevisionFqdn": "testcontainerapptcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io",
"latestReadyRevisionName": "testcontainerapptcp-pjxhsye",
"configuration": {
"ingress": {
"fqdn": "testcontainerapptcp.demokube-t24clv0g.eastus.containerApps.k4apps.io",
"external": true,
"targetPort": 3000,
"exposedPort": 4000,
"transport": "tcp",
"traffic": [
{
"weight": 80,
"revisionName": "testcontainerapptcp-ab1234"
},
{
"weight": 20,
"revisionName": "testcontainerapptcp-ab4321"
}
]
}
},
"template": {
"containers": [
{
"image": "repo/testcontainerapptcp:v4",
"name": "testcontainerapptcp",
"resources": {
"cpu": 0.5,
"memory": "1Gi"
},
"probes": [
{
"type": "Liveness",
"tcpSocket": {
"port": 8080
},
"initialDelaySeconds": 3,
"periodSeconds": 3
}
]
}
],
"scale": {
"minReplicas": 1,
"maxReplicas": 5,
"rules": [
{
"name": "tcpscalingrule",
"tcp": {
"metadata": {
"concurrentConnections": "50"
}
}
}
]
}
}
}
}
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapptcp",
"name": "testcontainerapptcp",
"type": "Microsoft.App/containerApps",
"location": "East US",
"properties": {
"provisioningState": "InProgress",
"managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube",
"latestRevisionFqdn": "testcontainerapptcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io",
"configuration": {
"ingress": {
"fqdn": "testcontainerapptcp.demokube-t24clv0g.eastus.containerApps.k4apps.io",
"external": true,
"targetPort": 3000,
"exposedPort": 4000,
"transport": "tcp",
"traffic": [
{
"weight": 80,
"revisionName": "testcontainerapptcp-ab1234"
},
{
"weight": 20,
"revisionName": "testcontainerapptcp-ab4321"
}
]
}
},
"template": {
"containers": [
{
"image": "repo/testcontainerapptcp:v4",
"name": "testcontainerapptcp",
"resources": {
"cpu": 0.5,
"memory": "1Gi"
},
"probes": [
{
"type": "Liveness",
"tcpSocket": {
"port": 8080
},
"initialDelaySeconds": 3,
"periodSeconds": 3
}
]
}
],
"scale": {
"minReplicas": 1,
"maxReplicas": 5,
"rules": [
{
"name": "tcpscalingrule",
"tcp": {
"metadata": {
"concurrentConnections": "50"
}
}
}
]
}
}
}
}
Definitions
Name | Description |
---|---|
action |
Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny |
Active |
ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default. |
affinity |
Sticky Session Affinity |
app |
Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http |
binding |
Custom Domain binding type. |
Configuration |
Non versioned Container App configuration properties that define the mutable settings of a Container app |
Container |
Container App container definition |
Container |
Container App. |
Container |
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. |
Container |
Provisioning state of the Container App. |
Container |
Container App container resource requirements. |
Cors |
Cross-Origin-Resource-Sharing policy |
created |
The type of identity that created the resource. |
Custom |
Custom Domain of a Container App |
Custom |
Container App container Custom scaling rule. |
Dapr |
Container App Dapr configuration. |
Default |
App Service error response. |
Details |
Details or the error |
Environment |
Container App container environment variable. |
Error |
Error model. |
Extended |
The complex type of the extended location. |
Extended |
The type of the extended location. |
Http |
HTTPGet specifies the http request to perform. |
Http |
Custom headers to set in the request. HTTP allows repeated headers. |
Http |
Container App container Http scaling rule. |
Ingress |
Container App Ingress configuration. |
Ingress |
Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require indicates server requires a client certificate. |
Ingress |
Port mappings of container app ingress |
Ingress |
Ingress transport protocol |
Init |
Container App init container definition |
Ip |
Rule to restrict incoming IP address. |
log |
Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. |
Managed |
Managed service identity (system assigned and/or user assigned identities) |
Managed |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
Queue |
Container App container Azure Queue based scaling rule. |
Registry |
Container App Private Registry |
Scale |
Container App scaling configurations. |
Scale |
Container App container scaling rule. |
Scale |
Auth Secrets for Scale Rule |
Scheme |
Scheme to use for connecting to the host. Defaults to HTTP. |
Secret |
Secret definition. |
Secret |
Secret to be added to volume. |
Service |
Container App to be a dev service |
Service |
Configuration to bind a ContainerApp to a dev ContainerApp Service |
Sticky |
Sticky Sessions for Single Revision Mode |
Storage |
Storage type for the volume. If not provided, use EmptyDir. |
system |
Metadata pertaining to creation and last modification of the resource. |
Tcp |
Container App container Tcp scaling rule. |
Tcp |
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. |
Template |
Container App versioned application definition. Defines the desired state of an immutable revision. Any changes to this section Will result in a new revision being created |
Traffic |
Traffic weight assigned to a revision |
Type |
The type of probe. |
User |
User assigned identity properties |
Volume |
Volume definitions for the Container App. |
Volume |
Volume mount for the Container App. |
action
Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny
Name | Type | Description |
---|---|---|
Allow |
string |
|
Deny |
string |
ActiveRevisionsMode
ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default.
Name | Type | Description |
---|---|---|
Multiple |
string |
|
Single |
string |
affinity
Sticky Session Affinity
Name | Type | Description |
---|---|---|
none |
string |
|
sticky |
string |
appProtocol
Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http
Name | Type | Description |
---|---|---|
grpc |
string |
|
http |
string |
bindingType
Custom Domain binding type.
Name | Type | Description |
---|---|---|
Disabled |
string |
|
SniEnabled |
string |
Configuration
Non versioned Container App configuration properties that define the mutable settings of a Container app
Name | Type | Default value | Description |
---|---|---|---|
activeRevisionsMode | Single |
ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default. |
|
dapr |
Dapr configuration for the Container App. |
||
ingress |
Ingress configurations. |
||
maxInactiveRevisions |
integer |
Optional. Max inactive revisions a Container App can have. |
|
registries |
Collection of private container registry credentials for containers used by the Container app |
||
secrets |
Secret[] |
Collection of secrets used by a Container app |
|
service |
Container App to be a dev Container App Service |
Container
Container App container definition
Name | Type | Description |
---|---|---|
args |
string[] |
Container start command arguments. |
command |
string[] |
Container start command. |
env |
Container environment variables. |
|
image |
string |
Container image tag. |
name |
string |
Custom container name. |
probes |
List of probes for the container. |
|
resources |
Container resource requirements. |
|
volumeMounts |
Container volume mounts. |
ContainerApp
Container App.
Name | Type | Description |
---|---|---|
extendedLocation |
The complex type of the extended location. |
|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. |
|
location |
string |
The geo-location where the resource lives |
managedBy |
string |
The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource. |
name |
string |
The name of the resource |
properties.configuration |
Non versioned Container App configuration properties. |
|
properties.customDomainVerificationId |
string |
Id used to verify domain name ownership |
properties.environmentId |
string |
Resource ID of environment. |
properties.eventStreamEndpoint |
string |
The endpoint of the eventstream of the container app. |
properties.latestReadyRevisionName |
string |
Name of the latest ready revision of the Container App. |
properties.latestRevisionFqdn |
string |
Fully Qualified Domain Name of the latest revision of the Container App. |
properties.latestRevisionName |
string |
Name of the latest revision of the Container App. |
properties.managedEnvironmentId |
string |
Deprecated. Resource ID of the Container App's environment. |
properties.outboundIpAddresses |
string[] |
Outbound IP Addresses for container app. |
properties.provisioningState |
Provisioning state of the Container App. |
|
properties.template |
Container App versioned application definition. |
|
properties.workloadProfileName |
string |
Workload profile name to pin for container app execution. |
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" |
ContainerAppProbe
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
Name | Type | Description |
---|---|---|
failureThreshold |
integer |
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10. |
httpGet |
HTTPGet specifies the http request to perform. |
|
initialDelaySeconds |
integer |
Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. |
periodSeconds |
integer |
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. |
successThreshold |
integer |
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10. |
tcpSocket |
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. |
|
terminationGracePeriodSeconds |
integer |
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour) |
timeoutSeconds |
integer |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. |
type |
The type of probe. |
ContainerAppProvisioningState
Provisioning state of the Container App.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Deleting |
string |
|
Failed |
string |
|
InProgress |
string |
|
Succeeded |
string |
ContainerResources
Container App container resource requirements.
Name | Type | Description |
---|---|---|
cpu |
number |
Required CPU in cores, e.g. 0.5 |
ephemeralStorage |
string |
Ephemeral Storage, e.g. "1Gi" |
memory |
string |
Required memory, e.g. "250Mb" |
CorsPolicy
Cross-Origin-Resource-Sharing policy
Name | Type | Description |
---|---|---|
allowCredentials |
boolean |
Specifies whether the resource allows credentials |
allowedHeaders |
string[] |
Specifies the content for the access-control-allow-headers header |
allowedMethods |
string[] |
Specifies the content for the access-control-allow-methods header |
allowedOrigins |
string[] |
Specifies the content for the access-control-allow-origins header |
exposeHeaders |
string[] |
Specifies the content for the access-control-expose-headers header |
maxAge |
integer |
Specifies the content for the access-control-max-age header |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
CustomDomain
Custom Domain of a Container App
Name | Type | Description |
---|---|---|
bindingType |
Custom Domain binding type. |
|
certificateId |
string |
Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. |
name |
string |
Hostname. |
CustomScaleRule
Container App container Custom scaling rule.
Name | Type | Description |
---|---|---|
auth |
Authentication secrets for the custom scale rule. |
|
metadata |
object |
Metadata properties to describe custom scale rule. |
type |
string |
Type of the custom scale rule eg: azure-servicebus, redis etc. |
Dapr
Container App Dapr configuration.
Name | Type | Default value | Description |
---|---|---|---|
appId |
string |
Dapr application identifier |
|
appPort |
integer |
Tells Dapr which port your application is listening on |
|
appProtocol | http |
Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http |
|
enableApiLogging |
boolean |
Enables API logging for the Dapr sidecar |
|
enabled |
boolean |
False |
Boolean indicating if the Dapr side car is enabled |
httpMaxRequestSize |
integer |
Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB. |
|
httpReadBufferSize |
integer |
Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. |
|
logLevel |
Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. |
DefaultErrorResponse
App Service error response.
Name | Type | Description |
---|---|---|
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. |
EnvironmentVar
Container App container environment variable.
Name | Type | Description |
---|---|---|
name |
string |
Environment variable name. |
secretRef |
string |
Name of the Container App secret from which to pull the environment variable value. |
value |
string |
Non-secret environment variable value. |
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. |
ExtendedLocation
The complex type of the extended location.
Name | Type | Description |
---|---|---|
name |
string |
The name of the extended location. |
type |
The type of the extended location. |
ExtendedLocationTypes
The type of the extended location.
Name | Type | Description |
---|---|---|
CustomLocation |
string |
HttpGet
HTTPGet specifies the http request to perform.
Name | Type | Description |
---|---|---|
host |
string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
httpHeaders |
Custom headers to set in the request. HTTP allows repeated headers. |
|
path |
string |
Path to access on the HTTP server. |
port |
integer |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
scheme |
Scheme to use for connecting to the host. Defaults to HTTP. |
HttpHeaders
Custom headers to set in the request. HTTP allows repeated headers.
Name | Type | Description |
---|---|---|
name |
string |
The header field name |
value |
string |
The header field value |
HttpScaleRule
Container App container Http scaling rule.
Name | Type | Description |
---|---|---|
auth |
Authentication secrets for the custom scale rule. |
|
metadata |
object |
Metadata properties to describe http scale rule. |
Ingress
Container App Ingress configuration.
Name | Type | Default value | Description |
---|---|---|---|
additionalPortMappings |
Settings to expose additional ports on container app |
||
allowInsecure |
boolean |
False |
Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections |
clientCertificateMode |
Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require indicates server requires a client certificate. |
||
corsPolicy |
CORS policy for container app |
||
customDomains |
custom domain bindings for Container Apps' hostnames. |
||
exposedPort |
integer |
Exposed Port in containers for TCP traffic from ingress |
|
external |
boolean |
False |
Bool indicating if app exposes an external http endpoint |
fqdn |
string |
Hostname. |
|
ipSecurityRestrictions |
Rules to restrict incoming IP address. |
||
stickySessions |
Sticky Sessions for Single Revision Mode |
||
targetPort |
integer |
Target Port in containers for traffic from ingress |
|
traffic |
Traffic weights for app's revisions |
||
transport | auto |
Ingress transport protocol |
IngressClientCertificateMode
Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require indicates server requires a client certificate.
Name | Type | Description |
---|---|---|
accept |
string |
|
ignore |
string |
|
require |
string |
IngressPortMapping
Port mappings of container app ingress
Name | Type | Description |
---|---|---|
exposedPort |
integer |
Specifies the exposed port for the target port. If not specified, it defaults to target port |
external |
boolean |
Specifies whether the app port is accessible outside of the environment |
targetPort |
integer |
Specifies the port user's container listens on |
IngressTransportMethod
Ingress transport protocol
Name | Type | Description |
---|---|---|
auto |
string |
|
http |
string |
|
http2 |
string |
|
tcp |
string |
InitContainer
Container App init container definition
Name | Type | Description |
---|---|---|
args |
string[] |
Container start command arguments. |
command |
string[] |
Container start command. |
env |
Container environment variables. |
|
image |
string |
Container image tag. |
name |
string |
Custom container name. |
resources |
Container resource requirements. |
|
volumeMounts |
Container volume mounts. |
IpSecurityRestrictionRule
Rule to restrict incoming IP address.
Name | Type | Description |
---|---|---|
action |
Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny |
|
description |
string |
Describe the IP restriction rule that is being sent to the container-app. This is an optional field. |
ipAddressRange |
string |
CIDR notation to match incoming IP address |
name |
string |
Name for the IP restriction rule. |
logLevel
Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.
Name | Type | Description |
---|---|---|
debug |
string |
|
error |
string |
|
info |
string |
|
warn |
string |
ManagedServiceIdentity
Managed service identity (system assigned and/or user assigned identities)
Name | Type | Description |
---|---|---|
principalId |
string |
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. |
tenantId |
string |
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. |
type |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
|
userAssignedIdentities |
<string,
User |
User-Assigned Identities |
ManagedServiceIdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Name | Type | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned,UserAssigned |
string |
|
UserAssigned |
string |
QueueScaleRule
Container App container Azure Queue based scaling rule.
Name | Type | Description |
---|---|---|
auth |
Authentication secrets for the queue scale rule. |
|
queueLength |
integer |
Queue length. |
queueName |
string |
Queue name. |
RegistryCredentials
Container App Private Registry
Name | Type | Description |
---|---|---|
identity |
string |
A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use 'system' |
passwordSecretRef |
string |
The name of the Secret that contains the registry login password |
server |
string |
Container Registry Server |
username |
string |
Container Registry Username |
Scale
Container App scaling configurations.
Name | Type | Default value | Description |
---|---|---|---|
maxReplicas |
integer |
10 |
Optional. Maximum number of container replicas. Defaults to 10 if not set. |
minReplicas |
integer |
Optional. Minimum number of container replicas. |
|
rules |
Scaling rules. |
ScaleRule
Container App container scaling rule.
Name | Type | Description |
---|---|---|
azureQueue |
Azure Queue based scaling. |
|
custom |
Custom scale rule. |
|
http |
HTTP requests based scaling. |
|
name |
string |
Scale Rule Name |
tcp |
Tcp requests based scaling. |
ScaleRuleAuth
Auth Secrets for Scale Rule
Name | Type | Description |
---|---|---|
secretRef |
string |
Name of the secret from which to pull the auth params. |
triggerParameter |
string |
Trigger Parameter that uses the secret |
Scheme
Scheme to use for connecting to the host. Defaults to HTTP.
Name | Type | Description |
---|---|---|
HTTP |
string |
|
HTTPS |
string |
Secret
Secret definition.
Name | Type | Description |
---|---|---|
identity |
string |
Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. |
keyVaultUrl |
string |
Azure Key Vault URL pointing to the secret referenced by the container app. |
name |
string |
Secret Name. |
value |
string |
Secret Value. |
SecretVolumeItem
Secret to be added to volume.
Name | Type | Description |
---|---|---|
path |
string |
Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. |
secretRef |
string |
Name of the Container App secret from which to pull the secret value. |
Service
Container App to be a dev service
Name | Type | Description |
---|---|---|
type |
string |
Dev ContainerApp service type |
ServiceBind
Configuration to bind a ContainerApp to a dev ContainerApp Service
Name | Type | Description |
---|---|---|
name |
string |
Name of the service bind |
serviceId |
string |
Resource id of the target service |
StickySessions
Sticky Sessions for Single Revision Mode
Name | Type | Description |
---|---|---|
affinity |
Sticky Session Affinity |
StorageType
Storage type for the volume. If not provided, use EmptyDir.
Name | Type | Description |
---|---|---|
AzureFile |
string |
|
EmptyDir |
string |
|
Secret |
string |
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 |
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 |
The type of identity that last modified the resource. |
TcpScaleRule
Container App container Tcp scaling rule.
Name | Type | Description |
---|---|---|
auth |
Authentication secrets for the tcp scale rule. |
|
metadata |
object |
Metadata properties to describe tcp scale rule. |
TcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.
Name | Type | Description |
---|---|---|
host |
string |
Optional: Host name to connect to, defaults to the pod IP. |
port |
integer |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
Template
Container App versioned application definition. Defines the desired state of an immutable revision. Any changes to this section Will result in a new revision being created
Name | Type | Description |
---|---|---|
containers |
List of container definitions for the Container App. |
|
initContainers |
List of specialized containers that run before app containers. |
|
revisionSuffix |
string |
User friendly suffix that is appended to the revision name |
scale |
Scaling properties for the Container App. |
|
serviceBinds |
List of container app services bound to the app |
|
terminationGracePeriodSeconds |
integer |
Optional duration in seconds the Container App Instance needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. |
volumes |
Volume[] |
List of volume definitions for the Container App. |
TrafficWeight
Traffic weight assigned to a revision
Name | Type | Default value | Description |
---|---|---|---|
label |
string |
Associates a traffic label with a revision |
|
latestRevision |
boolean |
False |
Indicates that the traffic weight belongs to a latest stable revision |
revisionName |
string |
Name of a revision |
|
weight |
integer |
Traffic weight assigned to a revision |
Type
The type of probe.
Name | Type | Description |
---|---|---|
Liveness |
string |
|
Readiness |
string |
|
Startup |
string |
UserAssignedIdentity
User assigned identity properties
Name | Type | Description |
---|---|---|
clientId |
string |
The client ID of the assigned identity. |
principalId |
string |
The principal ID of the assigned identity. |
Volume
Volume definitions for the Container App.
Name | Type | Description |
---|---|---|
mountOptions |
string |
Mount options used while mounting the AzureFile. Must be a comma-separated string. |
name |
string |
Volume name. |
secrets |
List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. |
|
storageName |
string |
Name of storage resource. No need to provide for EmptyDir and Secret. |
storageType |
Storage type for the volume. If not provided, use EmptyDir. |
VolumeMount
Volume mount for the Container App.
Name | Type | Description |
---|---|---|
mountPath |
string |
Path within the container at which the volume should be mounted.Must not contain ':'. |
subPath |
string |
Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). |
volumeName |
string |
This must match the Name of a Volume. |