PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/?api-version=2023-08-01-preview

The ID of the target subscription. The value must be an UUID.

Name of the Container App.

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

Default value: "application/json"

The complex type of the extended location.

The name of the extended location.

The type of extendedLocation.

Possible values:

• "CustomLocation"

The geo-location where the resource lives

ContainerApp resource specific properties

Name of the latest revision of the Container App.

Fully Qualified Domain Name of the latest revision of the Container App.

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

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.

User friendly suffix that is appended to the revision name

List of specialized containers that run before app containers.

Container volume mounts.

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

This must match the Name of a Volume.

Path within the container at which the volume should be mounted.Must not contain ':'.

Custom container name.

Container environment variables.

Environment variable name.

Name of the Container App secret from which to pull the environment variable value.

Non-secret environment variable value.

Container start command.

Container App container resource requirements.

Required memory, e.g. "250Mb"

Required CPU in cores, e.g. 0.5

Ephemeral Storage, e.g. "1Gi"

Container image tag.

Container start command arguments.

Container App scaling configurations.

Scaling rules.

Container App container Custom scaling rule.

Authentication secrets for the custom scale rule.

Trigger Parameter that uses the secret

Name of the secret from which to pull the auth params.

Type of the custom scale rule eg: azure-servicebus, redis etc.

Metadata properties to describe custom scale rule.

Container App container Azure Queue based scaling rule.

Authentication secrets for the queue scale rule.

Trigger Parameter that uses the secret

Name of the secret from which to pull the auth params.

Queue length.

Queue name.

Scale Rule Name

Container App container Tcp scaling rule.

Authentication secrets for the tcp scale rule.

Trigger Parameter that uses the secret

Name of the secret from which to pull the auth params.

Metadata properties to describe tcp scale rule.

Container App container Http scaling rule.

Authentication secrets for the custom scale rule.

Trigger Parameter that uses the secret

Name of the secret from which to pull the auth params.

Metadata properties to describe http scale rule.

Optional. Maximum number of container replicas. Defaults to 10 if not set.

Default value: 10

Optional. Minimum number of container replicas.

List of container app services bound to the app

Name of the service bind

Customized keys for customizing injected values to the app

Resource id of the target service

Type of the client to be used to connect to the service

List of container definitions for the Container App.

List of probes for the container.

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 specifies the http request to perform.

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.

Custom headers to set in the request. HTTP allows repeated headers.

The header field name

The header field value

Scheme to use for connecting to the host. Defaults to HTTP.

Possible values:

• "HTTP"
• "HTTPS"

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

Path to access on the HTTP server.

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.

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.

Optional: Host name to connect to, defaults to the pod IP.

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)

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.

Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.

The type of probe.

Possible values:

• "Startup"
• "Readiness"
• "Liveness"

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.

Container volume mounts.

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

This must match the Name of a Volume.

Path within the container at which the volume should be mounted.Must not contain ':'.

Custom container name.

Container environment variables.

Environment variable name.

Name of the Container App secret from which to pull the environment variable value.

Non-secret environment variable value.

Container start command.

Container App container resource requirements.

Required memory, e.g. "250Mb"

Required CPU in cores, e.g. 0.5

Ephemeral Storage, e.g. "1Gi"

Container image tag.

Container start command arguments.

List of volume definitions for the Container App.

Name of storage resource. No need to provide for EmptyDir and Secret.

Volume name.

Storage type for the volume. If not provided, use EmptyDir.

Possible values:

• "EmptyDir"
• "AzureFile"
• "Secret"

List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume.

Name of the Container App secret from which to pull the secret value.

Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef.

Mount options used while mounting the AzureFile. Must be a comma-separated string.

Provisioning state of the Container App.

Possible values:

• "Succeeded"
• "Deleting"
• "Canceled"
• "InProgress"
• "Failed"

Workload profile name for container apps to execute on.

Deprecated. Resource ID of the Container App's environment.

Non versioned Container App configuration properties that define the mutable settings of a Container app

Collection of private container registry credentials for containers used by the Container app

The name of the Secret that contains the registry login password

Container Registry Username

Container Registry Server

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'

Collection of secrets used by a Container app

Secret Name.

Azure Key Vault URL pointing to the secret referenced by the container app.

Secret Value.

Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.

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.

Possible values:

• "Single"
• "Multiple"

Default value: "Single"

Container App to be a dev service

Dev ContainerApp service type

Container App Dapr configuration.

Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http

Possible values:

• "grpc"
• "http"

Default value: "http"

Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB.

Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.

Possible values:

• "warn"
• "error"
• "debug"
• "info"

Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB.

Boolean indicating if the Dapr side car is enabled

Default value: false

Dapr application identifier

Tells Dapr which port your application is listening on

Enables API logging for the Dapr sidecar

Optional. Max inactive revisions a Container App can have.

Container App Ingress configuration.

Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections

Default value: false

Sticky Sessions for Single Revision Mode

Sticky Session Affinity

Possible values:

• "sticky"
• "none"

Cross-Origin-Resource-Sharing policy

Specifies whether the resource allows credentials

Specifies the content for the access-control-expose-headers header

Specifies the content for the access-control-allow-headers header

Specifies the content for the access-control-allow-origins header

Specifies the content for the access-control-allow-methods header

Specifies the content for the access-control-max-age header

Traffic weights for app's revisions

Associates a traffic label with a revision

Indicates that the traffic weight belongs to a latest stable revision

Default value: false

Traffic weight assigned to a revision

Name of a revision

Exposed Port in containers for TCP traffic from 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.

Possible values:

• "ignore"
• "require"
• "accept"

Target Port in containers for traffic from ingress

custom domain bindings for Container Apps' hostnames.

Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment.

Hostname.

Custom Domain binding type.

Possible values:

• "Disabled"
• "SniEnabled"

Bool indicating if app exposes an external http endpoint

Default value: false

Hostname.

Settings to expose additional ports on container app

Specifies the exposed port for the target port. If not specified, it defaults to target port

Specifies the port user's container listens on

Specifies whether the app port is accessible outside of the environment

Ingress transport protocol

Possible values:

• "auto"
• "tcp"
• "http"
• "http2"

Default value: "auto"

Rules to restrict incoming IP address.

Name for the IP restriction rule.

CIDR notation to match incoming IP address

Describe the IP restriction rule that is being sent to the container-app. This is an optional field.

Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny

Possible values:

• "Deny"
• "Allow"

Outbound IP Addresses for container app.

Name of the latest ready revision of the Container App.

Id used to verify domain name ownership

Resource ID of environment.

The endpoint of the eventstream of the container app.

Resource tags.

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.

Managed service identity (system assigned and/or user assigned identities)

The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Possible values:

• "SystemAssigned"
• "SystemAssigned,UserAssigned"
• "UserAssigned"
• "None"

The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.