Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{

Check notice on line 1 in specification/app/resource-manager/Microsoft.App/preview/2025-10-02-preview/SessionPools.json

View workflow job for this annotation

GitHub Actions / TypeSpec Requirement

Your service description will soon be required to convert from OpenAPI to TypeSpec. See https://aka.ms/azsdk/typespec.
"swagger": "2.0",
"info": {
"title": "ContainerApps API Client",
Expand Down Expand Up @@ -165,6 +165,9 @@
"x-ms-examples": {
"Get Session Pool": {
"$ref": "./examples/SessionPools_Get.json"
},
"Get Session Pool during update": {
"$ref": "./examples/SessionPools_Get_InProgress.json"
}
}
},
Expand Down Expand Up @@ -346,6 +349,88 @@
}
},
"definitions": {
"TemplatePoolStatus": {
"description": "The status of pods in the pool of this template.",
"type": "object",
"properties": {
"expectedCount": {
"description": "The expected count of pods in this pool",
"type": "integer",
"format": "int32"
},
"readyCount": {
"description": "The ready count of pods in this pool",
"type": "integer",
"format": "int32"
},
"pendingCount": {
"description": "The pending count of pods in this pool",
"type": "integer",
"format": "int32"
},
"imagePullFailCount": {
"description": "The image pull fail count of pods in this pool",
"type": "integer",
"format": "int32"
},
"crashCount": {
"description": "The crash count of pods in this pool",
"type": "integer",
"format": "int32"
},
"allocatedCount": {
"description": "The allocated count of pods in this pool",
"type": "integer",
"format": "int32"
}
}
},
"TemplateStatus": {
"description": "The status of the session pool template.",
"type": "object",
"properties": {
"details": {
"description": "The detailed status of this template.",
"type": "string"
},
"createdTime": {
"description": "The creation time of this template.",
"type": "string",
"format": "date-time"
},
"status": {
"description": "The status of this template.",
"$ref": "#/definitions/TemplatePoolStatus"
},
"containers": {
"description": "List of container definitions for the sessions of this template.",
"type": "array",
"items": {
"$ref": "#/definitions/SessionContainer"
},
"x-ms-identifiers": [
"name"
]
},
"ingress": {
"description": "Session pool ingress configuration of this template.",
"$ref": "#/definitions/SessionIngress"
}
}
},
"TemplateUpdateStatus": {
"type": "object",
"properties": {
"activeTemplate": {
"description": "The status of the current active template.",
"$ref": "#/definitions/TemplateStatus"
},
"desiredTemplate": {
"description": "The status of the desired template during session pool update.",
"$ref": "#/definitions/TemplateStatus"
}
}
},
"ScaleConfiguration": {
"description": "Scale configuration.",
"type": "object",
Expand Down Expand Up @@ -775,6 +860,14 @@
"description": "The network configuration of the sessions in the session pool.",
"$ref": "#/definitions/SessionNetworkConfiguration"
},
"templateUpdateStatus": {
"description": "The template status of the session pool, showing active template, or desired template during session pool update. This is only available if the containerType is CustomContainer.",
"$ref": "#/definitions/TemplateUpdateStatus",
"readOnly": true,
"x-ms-mutability": [
"read"
]
},
"poolManagementEndpoint": {
"description": "The endpoint to manage the pool.",
"type": "string",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,40 @@
"lifecycle": "Main"
}
],
"templateUpdateStatus": {
"activeTemplate": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you also add desiredTemplate in example?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, a new example added

"details": "Running",
"createdTime": "2025-10-02T00:00:00.000000Z",
"status": {
"expectedCount": 100,
"readyCount": 100,
"pendingCount": 0,
"imagePullFailCount": 0,
"crashCount": 0,
"allocatedCount": 0
},
"containers": [
{
"image": "repo/testcontainer:v4",
"name": "testinitcontainer",
"resources": {
"cpu": 0.25,
"memory": "0.5Gi"
},
"command": [
"/bin/sh"
],
"args": [
"-c",
"while true; do echo hello; sleep 10;done"
]
}
],
"ingress": {
"targetPort": 80
}
}
},
"poolManagementEndpoint": "https://testsessionpool.agreeableriver-3d30edf1.eastus.azurecontainerapps.io"
},
"identity": {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
{
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "rg",
"sessionPoolName": "testsessionpool",
"api-version": "2025-10-02-preview"
},
"responses": {
"200": {
"headers": {},
"body": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/sessionPools/testsessionpool",
"name": "testsessionpool",
"type": "Microsoft.App/sessionPools",
"location": "East US",
"properties": {
"provisioningState": "InProgress",
"environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube",
"poolManagementType": "Dynamic",
"containerType": "CustomContainer",
"nodeCount": 1,
"scaleConfiguration": {
"maxConcurrentSessions": 500,
"readySessionInstances": 100
},
"dynamicPoolConfiguration": {
"lifecycleConfiguration": {
"lifecycleType": "Timed",
"cooldownPeriodInSeconds": 600
}
},
"customContainerTemplate": {
"containers": [
{
"image": "repo/testcontainer:v5",
"name": "testinitcontainer",
"resources": {
"cpu": 0.25,
"memory": "0.5Gi"
},
"command": [
"/bin/sh"
],
"args": [
"-c",
"while true; do echo hello; sleep 10;done"
]
}
],
"ingress": {
"targetPort": 80
},
"registryCredentials": {
"server": "test.azurecr.io",
"identity": "/subscriptions/7a497526-bb8d-4816-9795-db1418a1f977/resourcegroups/test/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testSP"
}
},
"sessionNetworkConfiguration": {
"status": "EgressEnabled"
},
"managedIdentitySettings": [
{
"identity": "system",
"lifecycle": "Main"
}
],
"templateUpdateStatus": {
"activeTemplate": {
"details": "Running",
"createdTime": "2025-10-02T00:00:00.000000Z",
"status": {
"expectedCount": 100,
"readyCount": 100,
"pendingCount": 0,
"imagePullFailCount": 0,
"crashCount": 0,
"allocatedCount": 0
},
"containers": [
{
"image": "repo/testcontainer:v4",
"name": "testinitcontainer",
"resources": {
"cpu": 0.25,
"memory": "0.5Gi"
},
"command": [
"/bin/sh"
],
"args": [
"-c",
"while true; do echo hello; sleep 10;done"
]
}
],
"ingress": {
"targetPort": 80
}
},
"desiredTemplate": {
"details": "Updating",
"createdTime": "2025-10-02T05:00:00.000000Z",
"status": {
"expectedCount": 100,
"readyCount": 0,
"pendingCount": 0,
"imagePullFailCount": 0,
"crashCount": 0,
"allocatedCount": 0
},
"containers": [
{
"image": "repo/testcontainer:v5",
"name": "testinitcontainer",
"resources": {
"cpu": 0.25,
"memory": "0.5Gi"
},
"command": [
"/bin/sh"
],
"args": [
"-c",
"while true; do echo hello; sleep 10;done"
]
}
],
"ingress": {
"targetPort": 80
}
}
},
"poolManagementEndpoint": "https://testsessionpool.agreeableriver-3d30edf1.eastus.azurecontainerapps.io"
},
"identity": {
"type": "SystemAssigned",
"principalId": "bce8c037-3d10-44a4-a970-25f799611fc6",
"tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
}
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,40 @@
"sessionNetworkConfiguration": {
"status": "EgressEnabled"
},
"templateUpdateStatus": {
"activeTemplate": {
"details": "Running",
"createdTime": "2025-10-02T00:00:00.000000Z",
"status": {
"expectedCount": 100,
"readyCount": 100,
"pendingCount": 0,
"imagePullFailCount": 0,
"crashCount": 0,
"allocatedCount": 0
},
"containers": [
{
"image": "repo/testcontainer:v4",
"name": "testinitcontainer",
"resources": {
"cpu": 0.25,
"memory": "0.5Gi"
},
"command": [
"/bin/sh"
],
"args": [
"-c",
"while true; do echo hello; sleep 10;done"
]
}
],
"ingress": {
"targetPort": 80
}
}
},
"poolManagementEndpoint": "https://testsessionpool.agreeableriver-3d30edf1.eastus.azurecontainerapps.io"
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,40 @@
"sessionNetworkConfiguration": {
"status": "EgressEnabled"
},
"templateUpdateStatus": {
"activeTemplate": {
"details": "Running",
"createdTime": "2025-10-02T00:00:00.000000Z",
"status": {
"expectedCount": 100,
"readyCount": 100,
"pendingCount": 0,
"imagePullFailCount": 0,
"crashCount": 0,
"allocatedCount": 0
},
"containers": [
{
"image": "repo/testcontainer:v4",
"name": "testinitcontainer",
"resources": {
"cpu": 0.25,
"memory": "0.5Gi"
},
"command": [
"/bin/sh"
],
"args": [
"-c",
"while true; do echo hello; sleep 10;done"
]
}
],
"ingress": {
"targetPort": 80
}
}
},
"poolManagementEndpoint": "https://testsessionpool.agreeableriver-3d30edf1.eastus.azurecontainerapps.io"
}
}
Expand Down