Microsoft.App sessionPools

2025-05-13

Bicep resource definition

The sessionPools resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.App/sessionPools resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.App/sessionPools@2025-02-02-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    containerType: 'string'
    customContainerTemplate: {
      containers: [
        {
          args: [
            'string'
          ]
          command: [
            'string'
          ]
          env: [
            {
              name: 'string'
              secretRef: 'string'
              value: 'string'
            }
          ]
          image: 'string'
          name: 'string'
          probes: [
            {
              failureThreshold: int
              httpGet: {
                host: 'string'
                httpHeaders: [
                  {
                    name: 'string'
                    value: 'string'
                  }
                ]
                path: 'string'
                port: int
                scheme: 'string'
              }
              initialDelaySeconds: int
              periodSeconds: int
              successThreshold: int
              tcpSocket: {
                host: 'string'
                port: int
              }
              terminationGracePeriodSeconds: int
              timeoutSeconds: int
              type: 'string'
            }
          ]
          resources: {
            cpu: int
            memory: 'string'
          }
        }
      ]
      ingress: {
        targetPort: int
      }
      registryCredentials: {
        identity: 'string'
        passwordSecretRef: 'string'
        server: 'string'
        username: 'string'
      }
    }
    dynamicPoolConfiguration: {
      lifecycleConfiguration: {
        cooldownPeriodInSeconds: int
        lifecycleType: 'string'
        maxAlivePeriodInSeconds: int
      }
    }
    environmentId: 'string'
    managedIdentitySettings: [
      {
        identity: 'string'
        lifecycle: 'string'
      }
    ]
    poolManagementType: 'string'
    scaleConfiguration: {
      maxConcurrentSessions: int
      readySessionInstances: int
    }
    secrets: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    sessionNetworkConfiguration: {
      status: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.App/sessionPools

Name	Description	Value
identity	Managed identities needed by a session pool to interact with other Azure services to not maintain any secrets or credentials in code.	ManagedServiceIdentity
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 3 Max length = 63 Pattern = `^[a-z][a-z0-9]*$` (required)
properties	Container App session pool resource specific properties	SessionPoolProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

CustomContainerTemplate

Name	Description	Value
containers	List of container definitions for the sessions of the session pool.	SessionContainer[]
ingress	Session pool ingress configuration.	SessionIngress
registryCredentials	Private container registry credentials for containers used by the sessions of the session pool.	SessionRegistryCredentials

DynamicPoolConfiguration

Name	Description	Value
lifecycleConfiguration	The lifecycle configuration of a session in the dynamic session pool	LifecycleConfiguration

EnvironmentVar

Name	Description	Value
name	Environment variable name.	string
secretRef	Name of the Container App secret from which to pull the environment variable value.	string
value	Non-secret environment variable value.	string

LifecycleConfiguration

Name	Description	Value
cooldownPeriodInSeconds	The cooldown period of a session in seconds when the lifecycle type is 'Timed'.	int
lifecycleType	The lifecycle type of the session pool.	'OnContainerExit' 'Timed'
maxAlivePeriodInSeconds	The maximum alive period of a session in seconds when the lifecycle type is 'OnContainerExit'.	int

ManagedIdentitySetting

Name	Description	Value
identity	The resource ID of a user-assigned managed identity that is assigned to the Session Pool, or 'system' for system-assigned identity.	string (required)
lifecycle	Use to select the lifecycle stages of a Session Pool during which the Managed Identity should be available.	'All' 'Init' 'Main' 'None'

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	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.	UserAssignedIdentities

ScaleConfiguration

Name	Description	Value
maxConcurrentSessions	The maximum count of sessions at the same time.	int
readySessionInstances	The minimum count of ready session instances.	int

SessionContainer

Name	Description	Value
args	Container start command arguments.	string[]
command	Container start command.	string[]
env	Container environment variables.	EnvironmentVar[]
image	Container image tag.	string
name	Custom container name.	string
probes	List of probes for the container.	SessionProbe[]
resources	Container resource requirements.	SessionContainerResources

SessionContainerResources

Name	Description	Value
cpu	Required CPU in cores, e.g. 0.5	int
memory	Required memory, e.g. "250Mb"	string

SessionIngress

Name	Description	Value
targetPort	Target port in containers for traffic from ingress	int

SessionNetworkConfiguration

Name	Description	Value
status	Network status for the sessions.	'EgressDisabled' 'EgressEnabled'

SessionPoolProperties

Name	Description	Value
containerType	The container type of the sessions.	'CustomContainer' 'PythonLTS'
customContainerTemplate	The custom container configuration if the containerType is CustomContainer.	CustomContainerTemplate
dynamicPoolConfiguration	The pool configuration if the poolManagementType is dynamic.	DynamicPoolConfiguration
environmentId	Resource ID of the session pool's environment.	string
managedIdentitySettings	Optional settings for a Managed Identity that is assigned to the Session pool.	ManagedIdentitySetting[]
poolManagementType	The pool management type of the session pool.	'Dynamic' 'Manual'
scaleConfiguration	The scale configuration of the session pool.	ScaleConfiguration
secrets	The secrets of the session pool.	SessionPoolSecret[]
sessionNetworkConfiguration	The network configuration of the sessions in the session pool.	SessionNetworkConfiguration

SessionPoolSecret

Name	Description	Value
name	Secret Name.	string
value	Secret Value.	string Constraints: Sensitive value. Pass in as a secure parameter.

SessionProbe

Name	Description	Value
failureThreshold	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10.	int
httpGet	HTTPGet specifies the http request to perform.	SessionProbeHttpGet
initialDelaySeconds	Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.	int
periodSeconds	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.	int
successThreshold	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.	int
tcpSocket	TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.	SessionProbeTcpSocket
terminationGracePeriodSeconds	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)	int
timeoutSeconds	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.	int
type	Denotes the type of probe. Can be Liveness or Startup, Readiness probe is not supported in sessions. Type must be unique for each probe within the context of a list of probes (SessionProbes).	'Liveness' 'Startup'

SessionProbeHttpGet

Name	Description	Value
host	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	string
httpHeaders	Custom headers to set in the request. HTTP allows repeated headers.	SessionProbeHttpGetHttpHeadersItem[]
path	Path to access on the HTTP server.	string
port	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.	int (required)
scheme	Scheme to use for connecting to the host. Defaults to HTTP.	'HTTP' 'HTTPS'

SessionProbeHttpGetHttpHeadersItem

Name	Description	Value
name	The header field name	string (required)
value	The header field value	string (required)

SessionProbeTcpSocket

Name	Description	Value
host	Optional: Host name to connect to, defaults to the pod IP.	string
port	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.	int (required)

SessionRegistryCredentials

Name	Description	Value
identity	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'	string
passwordSecretRef	The name of the secret that contains the registry login password	string
server	Container registry server.	string
username	Container registry username.	string

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module	Description
App Session Pool	AVM Resource Module for App Session Pool

ARM template resource definition

The sessionPools resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.App/sessionPools resource, add the following JSON to your template.

{
  "type": "Microsoft.App/sessionPools",
  "apiVersion": "2025-02-02-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "containerType": "string",
    "customContainerTemplate": {
      "containers": [
        {
          "args": [ "string" ],
          "command": [ "string" ],
          "env": [
            {
              "name": "string",
              "secretRef": "string",
              "value": "string"
            }
          ],
          "image": "string",
          "name": "string",
          "probes": [
            {
              "failureThreshold": "int",
              "httpGet": {
                "host": "string",
                "httpHeaders": [
                  {
                    "name": "string",
                    "value": "string"
                  }
                ],
                "path": "string",
                "port": "int",
                "scheme": "string"
              },
              "initialDelaySeconds": "int",
              "periodSeconds": "int",
              "successThreshold": "int",
              "tcpSocket": {
                "host": "string",
                "port": "int"
              },
              "terminationGracePeriodSeconds": "int",
              "timeoutSeconds": "int",
              "type": "string"
            }
          ],
          "resources": {
            "cpu": "int",
            "memory": "string"
          }
        }
      ],
      "ingress": {
        "targetPort": "int"
      },
      "registryCredentials": {
        "identity": "string",
        "passwordSecretRef": "string",
        "server": "string",
        "username": "string"
      }
    },
    "dynamicPoolConfiguration": {
      "lifecycleConfiguration": {
        "cooldownPeriodInSeconds": "int",
        "lifecycleType": "string",
        "maxAlivePeriodInSeconds": "int"
      }
    },
    "environmentId": "string",
    "managedIdentitySettings": [
      {
        "identity": "string",
        "lifecycle": "string"
      }
    ],
    "poolManagementType": "string",
    "scaleConfiguration": {
      "maxConcurrentSessions": "int",
      "readySessionInstances": "int"
    },
    "secrets": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "sessionNetworkConfiguration": {
      "status": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.App/sessionPools

Name	Description	Value
apiVersion	The api version	'2025-02-02-preview'
identity	Managed identities needed by a session pool to interact with other Azure services to not maintain any secrets or credentials in code.	ManagedServiceIdentity
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 3 Max length = 63 Pattern = `^[a-z][a-z0-9]*$` (required)
properties	Container App session pool resource specific properties	SessionPoolProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.App/sessionPools'

CustomContainerTemplate

Name	Description	Value
containers	List of container definitions for the sessions of the session pool.	SessionContainer[]
ingress	Session pool ingress configuration.	SessionIngress
registryCredentials	Private container registry credentials for containers used by the sessions of the session pool.	SessionRegistryCredentials

DynamicPoolConfiguration

Name	Description	Value
lifecycleConfiguration	The lifecycle configuration of a session in the dynamic session pool	LifecycleConfiguration

EnvironmentVar

Name	Description	Value
name	Environment variable name.	string
secretRef	Name of the Container App secret from which to pull the environment variable value.	string
value	Non-secret environment variable value.	string

LifecycleConfiguration

Name	Description	Value
cooldownPeriodInSeconds	The cooldown period of a session in seconds when the lifecycle type is 'Timed'.	int
lifecycleType	The lifecycle type of the session pool.	'OnContainerExit' 'Timed'
maxAlivePeriodInSeconds	The maximum alive period of a session in seconds when the lifecycle type is 'OnContainerExit'.	int

ManagedIdentitySetting

Name	Description	Value
identity	The resource ID of a user-assigned managed identity that is assigned to the Session Pool, or 'system' for system-assigned identity.	string (required)
lifecycle	Use to select the lifecycle stages of a Session Pool during which the Managed Identity should be available.	'All' 'Init' 'Main' 'None'

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	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.	UserAssignedIdentities

ScaleConfiguration

Name	Description	Value
maxConcurrentSessions	The maximum count of sessions at the same time.	int
readySessionInstances	The minimum count of ready session instances.	int

SessionContainer

Name	Description	Value
args	Container start command arguments.	string[]
command	Container start command.	string[]
env	Container environment variables.	EnvironmentVar[]
image	Container image tag.	string
name	Custom container name.	string
probes	List of probes for the container.	SessionProbe[]
resources	Container resource requirements.	SessionContainerResources

SessionContainerResources

Name	Description	Value
cpu	Required CPU in cores, e.g. 0.5	int
memory	Required memory, e.g. "250Mb"	string

SessionIngress

Name	Description	Value
targetPort	Target port in containers for traffic from ingress	int

SessionNetworkConfiguration

Name	Description	Value
status	Network status for the sessions.	'EgressDisabled' 'EgressEnabled'

SessionPoolProperties

Name	Description	Value
containerType	The container type of the sessions.	'CustomContainer' 'PythonLTS'
customContainerTemplate	The custom container configuration if the containerType is CustomContainer.	CustomContainerTemplate
dynamicPoolConfiguration	The pool configuration if the poolManagementType is dynamic.	DynamicPoolConfiguration
environmentId	Resource ID of the session pool's environment.	string
managedIdentitySettings	Optional settings for a Managed Identity that is assigned to the Session pool.	ManagedIdentitySetting[]
poolManagementType	The pool management type of the session pool.	'Dynamic' 'Manual'
scaleConfiguration	The scale configuration of the session pool.	ScaleConfiguration
secrets	The secrets of the session pool.	SessionPoolSecret[]
sessionNetworkConfiguration	The network configuration of the sessions in the session pool.	SessionNetworkConfiguration

SessionPoolSecret

Name	Description	Value
name	Secret Name.	string
value	Secret Value.	string Constraints: Sensitive value. Pass in as a secure parameter.

SessionProbe

Name	Description	Value
failureThreshold	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10.	int
httpGet	HTTPGet specifies the http request to perform.	SessionProbeHttpGet
initialDelaySeconds	Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.	int
periodSeconds	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.	int
successThreshold	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.	int
tcpSocket	TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.	SessionProbeTcpSocket
terminationGracePeriodSeconds	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)	int
timeoutSeconds	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.	int
type	Denotes the type of probe. Can be Liveness or Startup, Readiness probe is not supported in sessions. Type must be unique for each probe within the context of a list of probes (SessionProbes).	'Liveness' 'Startup'

SessionProbeHttpGet

Name	Description	Value
host	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	string
httpHeaders	Custom headers to set in the request. HTTP allows repeated headers.	SessionProbeHttpGetHttpHeadersItem[]
path	Path to access on the HTTP server.	string
port	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.	int (required)
scheme	Scheme to use for connecting to the host. Defaults to HTTP.	'HTTP' 'HTTPS'

SessionProbeHttpGetHttpHeadersItem

Name	Description	Value
name	The header field name	string (required)
value	The header field value	string (required)

SessionProbeTcpSocket

Name	Description	Value
host	Optional: Host name to connect to, defaults to the pod IP.	string
port	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.	int (required)

SessionRegistryCredentials

Name	Description	Value
identity	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'	string
passwordSecretRef	The name of the secret that contains the registry login password	string
server	Container registry server.	string
username	Container registry username.	string

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

Usage Examples

Terraform (AzAPI provider) resource definition

The sessionPools resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.App/sessionPools resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.App/sessionPools@2025-02-02-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      containerType = "string"
      customContainerTemplate = {
        containers = [
          {
            args = [
              "string"
            ]
            command = [
              "string"
            ]
            env = [
              {
                name = "string"
                secretRef = "string"
                value = "string"
              }
            ]
            image = "string"
            name = "string"
            probes = [
              {
                failureThreshold = int
                httpGet = {
                  host = "string"
                  httpHeaders = [
                    {
                      name = "string"
                      value = "string"
                    }
                  ]
                  path = "string"
                  port = int
                  scheme = "string"
                }
                initialDelaySeconds = int
                periodSeconds = int
                successThreshold = int
                tcpSocket = {
                  host = "string"
                  port = int
                }
                terminationGracePeriodSeconds = int
                timeoutSeconds = int
                type = "string"
              }
            ]
            resources = {
              cpu = int
              memory = "string"
            }
          }
        ]
        ingress = {
          targetPort = int
        }
        registryCredentials = {
          identity = "string"
          passwordSecretRef = "string"
          server = "string"
          username = "string"
        }
      }
      dynamicPoolConfiguration = {
        lifecycleConfiguration = {
          cooldownPeriodInSeconds = int
          lifecycleType = "string"
          maxAlivePeriodInSeconds = int
        }
      }
      environmentId = "string"
      managedIdentitySettings = [
        {
          identity = "string"
          lifecycle = "string"
        }
      ]
      poolManagementType = "string"
      scaleConfiguration = {
        maxConcurrentSessions = int
        readySessionInstances = int
      }
      secrets = [
        {
          name = "string"
          value = "string"
        }
      ]
      sessionNetworkConfiguration = {
        status = "string"
      }
    }
  }
}

Property Values

Microsoft.App/sessionPools

Name	Description	Value
identity	Managed identities needed by a session pool to interact with other Azure services to not maintain any secrets or credentials in code.	ManagedServiceIdentity
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 3 Max length = 63 Pattern = `^[a-z][a-z0-9]*$` (required)
properties	Container App session pool resource specific properties	SessionPoolProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.App/sessionPools@2025-02-02-preview"

CustomContainerTemplate

Name	Description	Value
containers	List of container definitions for the sessions of the session pool.	SessionContainer[]
ingress	Session pool ingress configuration.	SessionIngress
registryCredentials	Private container registry credentials for containers used by the sessions of the session pool.	SessionRegistryCredentials

DynamicPoolConfiguration

Name	Description	Value
lifecycleConfiguration	The lifecycle configuration of a session in the dynamic session pool	LifecycleConfiguration

EnvironmentVar

Name	Description	Value
name	Environment variable name.	string
secretRef	Name of the Container App secret from which to pull the environment variable value.	string
value	Non-secret environment variable value.	string

LifecycleConfiguration

Name	Description	Value
cooldownPeriodInSeconds	The cooldown period of a session in seconds when the lifecycle type is 'Timed'.	int
lifecycleType	The lifecycle type of the session pool.	'OnContainerExit' 'Timed'
maxAlivePeriodInSeconds	The maximum alive period of a session in seconds when the lifecycle type is 'OnContainerExit'.	int

ManagedIdentitySetting

Name	Description	Value
identity	The resource ID of a user-assigned managed identity that is assigned to the Session Pool, or 'system' for system-assigned identity.	string (required)
lifecycle	Use to select the lifecycle stages of a Session Pool during which the Managed Identity should be available.	'All' 'Init' 'Main' 'None'

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	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.	UserAssignedIdentities

ScaleConfiguration

Name	Description	Value
maxConcurrentSessions	The maximum count of sessions at the same time.	int
readySessionInstances	The minimum count of ready session instances.	int

SessionContainer

Name	Description	Value
args	Container start command arguments.	string[]
command	Container start command.	string[]
env	Container environment variables.	EnvironmentVar[]
image	Container image tag.	string
name	Custom container name.	string
probes	List of probes for the container.	SessionProbe[]
resources	Container resource requirements.	SessionContainerResources

SessionContainerResources

Name	Description	Value
cpu	Required CPU in cores, e.g. 0.5	int
memory	Required memory, e.g. "250Mb"	string

SessionIngress

Name	Description	Value
targetPort	Target port in containers for traffic from ingress	int

SessionNetworkConfiguration

Name	Description	Value
status	Network status for the sessions.	'EgressDisabled' 'EgressEnabled'

SessionPoolProperties

Name	Description	Value
containerType	The container type of the sessions.	'CustomContainer' 'PythonLTS'
customContainerTemplate	The custom container configuration if the containerType is CustomContainer.	CustomContainerTemplate
dynamicPoolConfiguration	The pool configuration if the poolManagementType is dynamic.	DynamicPoolConfiguration
environmentId	Resource ID of the session pool's environment.	string
managedIdentitySettings	Optional settings for a Managed Identity that is assigned to the Session pool.	ManagedIdentitySetting[]
poolManagementType	The pool management type of the session pool.	'Dynamic' 'Manual'
scaleConfiguration	The scale configuration of the session pool.	ScaleConfiguration
secrets	The secrets of the session pool.	SessionPoolSecret[]
sessionNetworkConfiguration	The network configuration of the sessions in the session pool.	SessionNetworkConfiguration

SessionPoolSecret

Name	Description	Value
name	Secret Name.	string
value	Secret Value.	string Constraints: Sensitive value. Pass in as a secure parameter.

SessionProbe

Name	Description	Value
failureThreshold	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10.	int
httpGet	HTTPGet specifies the http request to perform.	SessionProbeHttpGet
initialDelaySeconds	Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.	int
periodSeconds	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.	int
successThreshold	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.	int
tcpSocket	TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.	SessionProbeTcpSocket
terminationGracePeriodSeconds	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)	int
timeoutSeconds	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.	int
type	Denotes the type of probe. Can be Liveness or Startup, Readiness probe is not supported in sessions. Type must be unique for each probe within the context of a list of probes (SessionProbes).	'Liveness' 'Startup'

SessionProbeHttpGet

Name	Description	Value
host	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	string
httpHeaders	Custom headers to set in the request. HTTP allows repeated headers.	SessionProbeHttpGetHttpHeadersItem[]
path	Path to access on the HTTP server.	string
port	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.	int (required)
scheme	Scheme to use for connecting to the host. Defaults to HTTP.	'HTTP' 'HTTPS'

SessionProbeHttpGetHttpHeadersItem

Name	Description	Value
name	The header field name	string (required)
value	The header field value	string (required)

SessionProbeTcpSocket

Name	Description	Value
host	Optional: Host name to connect to, defaults to the pod IP.	string
port	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.	int (required)

SessionRegistryCredentials

Name	Description	Value
identity	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'	string
passwordSecretRef	The name of the secret that contains the registry login password	string
server	Container registry server.	string
username	Container registry username.	string

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

Share via

Microsoft.App sessionPools

Bicep resource definition

Resource format

Property Values

Microsoft.App/sessionPools

CustomContainerTemplate

DynamicPoolConfiguration

EnvironmentVar

LifecycleConfiguration

ManagedIdentitySetting

ManagedServiceIdentity

ScaleConfiguration

SessionContainer

SessionContainerResources

SessionIngress

SessionNetworkConfiguration

SessionPoolProperties

SessionPoolSecret

SessionProbe

SessionProbeHttpGet

SessionProbeHttpGetHttpHeadersItem

SessionProbeTcpSocket

SessionRegistryCredentials

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

Usage Examples

Azure Verified Modules

ARM template resource definition

Resource format

Property Values

Microsoft.App/sessionPools

CustomContainerTemplate

DynamicPoolConfiguration

EnvironmentVar

LifecycleConfiguration

ManagedIdentitySetting

ManagedServiceIdentity

ScaleConfiguration

SessionContainer

SessionContainerResources

SessionIngress

SessionNetworkConfiguration

SessionPoolProperties

SessionPoolSecret

SessionProbe

SessionProbeHttpGet

SessionProbeHttpGetHttpHeadersItem

SessionProbeTcpSocket

SessionRegistryCredentials

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

Usage Examples

Terraform (AzAPI provider) resource definition

Resource format

Property Values

Microsoft.App/sessionPools

CustomContainerTemplate

DynamicPoolConfiguration

EnvironmentVar

LifecycleConfiguration

ManagedIdentitySetting

ManagedServiceIdentity

ScaleConfiguration

SessionContainer

SessionContainerResources

SessionIngress

SessionNetworkConfiguration

SessionPoolProperties

SessionPoolSecret

SessionProbe

SessionProbeHttpGet

SessionProbeHttpGetHttpHeadersItem

SessionProbeTcpSocket

SessionRegistryCredentials

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity