Container Apps Revisions - Get Revision
Get a revision of a Container App.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}?api-version=2025-01-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
container
|
path | True |
string |
Name of the Container App. |
resource
|
path | True |
string minLength: 1maxLength: 90 |
The name of the resource group. The name is case insensitive. |
revision
|
path | True |
string |
Name of the Container App Revision. |
subscription
|
path | True |
string minLength: 1 |
The ID of the target subscription. |
api-version
|
query | True |
string minLength: 1 |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
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
Get Container App's revision
Sample request
Sample response
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0/revisions/testcontainerApp0-pjxhsye",
"name": "testcontainerApp0-pjxhsye",
"type": "Microsoft.App/containerApps/revisions",
"properties": {
"createdTime": "2021-05-24T21:24:22+00:00",
"lastActiveTime": "2021-05-24T21:24:22+00:00",
"fqdn": "testcontainerApp0-pjxhsye.politehill-ab123456.eastus.azurecontainerapps.io",
"template": {
"containers": [
{
"image": "repo/testcontainerApp0:v2",
"name": "testcontainerApp0",
"resources": {
"cpu": 0.2,
"memory": "100Mi"
}
}
],
"scale": {
"minReplicas": 1,
"maxReplicas": 5,
"rules": [
{
"name": "httpscalingrule",
"http": {
"metadata": {
"concurrentRequests": "50"
}
}
}
]
}
},
"trafficWeight": 80,
"active": true,
"replicas": 1,
"runningState": "Running"
}
}
Definitions
Name | Description |
---|---|
Container |
Container App container definition |
Container |
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. |
Container |
Container App container resource requirements. |
created |
The type of identity that created the resource. |
Custom |
Container App container Custom scaling rule. |
Default |
App Service error response. |
Details |
Details or the error |
Environment |
Container App container environment variable. |
Error |
Error model. |
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. |
Init |
Container App init container definition |
Queue |
Container App container Azure Queue based scaling rule. |
Revision |
Container App Revision. |
Revision |
Current health State of the revision |
Revision |
Current provisioning State of the revision |
Revision |
Current running state of the revision |
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 to be added to volume. |
Service |
Configuration to bind a ContainerApp to a dev ContainerApp Service |
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 |
Type |
The type of probe. |
Volume |
Volume definitions for the Container App. |
Volume |
Volume mount for the Container App. |
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. |
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 (int32) |
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 (int32) |
Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. |
periodSeconds |
integer (int32) |
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. |
successThreshold |
integer (int32) |
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 (int64) |
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 (int32) |
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. |
ContainerResources
Container App container resource requirements.
Name | Type | Description |
---|---|---|
cpu |
number (double) |
Required CPU in cores, e.g. 0.5 |
ephemeralStorage |
string |
Ephemeral Storage, e.g. "1Gi" |
memory |
string |
Required memory, e.g. "250Mb" |
createdByType
The type of identity that created the resource.
Value | Description |
---|---|
User | |
Application | |
ManagedIdentity | |
Key |
CustomScaleRule
Container App container Custom scaling rule.
Name | Type | Description |
---|---|---|
auth |
Authentication secrets for the custom scale rule. |
|
identity |
string |
The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. |
metadata |
object |
Metadata properties to describe custom scale rule. |
type |
string |
Type of the custom scale rule eg: azure-servicebus, redis etc. |
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. |
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 (int32) |
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. |
|
identity |
string |
The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. |
metadata |
object |
Metadata properties to describe http scale rule. |
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. |
QueueScaleRule
Container App container Azure Queue based scaling rule.
Name | Type | Description |
---|---|---|
accountName |
string |
Storage account name. required if using managed identity to authenticate |
auth |
Authentication secrets for the queue scale rule. |
|
identity |
string |
The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. |
queueLength |
integer (int32) |
Queue length. |
queueName |
string |
Queue name. |
Revision
Container App Revision.
Name | Type | Description |
---|---|---|
id |
string (arm-id) |
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name |
string |
The name of the resource |
properties.active |
boolean |
Boolean describing if the Revision is Active |
properties.createdTime |
string (date-time) |
Timestamp describing when the revision was created by controller |
properties.fqdn |
string |
Fully qualified domain name of the revision |
properties.healthState |
Current health State of the revision |
|
properties.lastActiveTime |
string (date-time) |
Timestamp describing when the revision was last active. Only meaningful when revision is inactive |
properties.provisioningError |
string |
Optional Field - Platform Error Message |
properties.provisioningState |
Current provisioning State of the revision |
|
properties.replicas |
integer (int32) |
Number of pods currently running for this revision |
properties.runningState |
Current running state of the revision |
|
properties.template |
Container App Revision Template with all possible settings and the defaults if user did not provide them. The defaults are populated as they were at the creation time |
|
properties.trafficWeight |
integer (int32) |
Traffic weight assigned to this revision |
systemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
RevisionHealthState
Current health State of the revision
Value | Description |
---|---|
Healthy | |
Unhealthy | |
None |
RevisionProvisioningState
Current provisioning State of the revision
Value | Description |
---|---|
Provisioning | |
Provisioned | |
Failed | |
Deprovisioning | |
Deprovisioned |
RevisionRunningState
Current running state of the revision
Value | Description |
---|---|
Running | |
Processing | |
Stopped | |
Degraded | |
Failed | |
Unknown |
Scale
Container App scaling configurations.
Name | Type | Default value | Description |
---|---|---|---|
cooldownPeriod |
integer (int32) |
Optional. KEDA Cooldown Period in seconds. Defaults to 300 seconds if not set. |
|
maxReplicas |
integer (int32) |
10 |
Optional. Maximum number of container replicas. Defaults to 10 if not set. |
minReplicas |
integer (int32) |
Optional. Minimum number of container replicas. |
|
pollingInterval |
integer (int32) |
Optional. KEDA Polling Interval in seconds. Defaults to 30 seconds if not set. |
|
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.
Value | Description |
---|---|
HTTP | |
HTTPS |
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. |
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 |
StorageType
Storage type for the volume. If not provided, use EmptyDir.
Value | Description |
---|---|
AzureFile | |
EmptyDir | |
Secret | |
NfsAzureFile |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string (date-time) |
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 (date-time) |
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. |
|
identity |
string |
The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. |
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 (int32) |
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 (int64) |
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. |
Type
The type of probe.
Value | Description |
---|---|
Liveness | |
Readiness | |
Startup |
Volume
Volume definitions for the Container App.
Name | Type | Description |
---|---|---|
mountOptions |
string |
Mount options used while mounting the Azure file share or NFS Azure file share. 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. |