Share via

SessionPool Class

  • Reference

Container App session pool.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Constructor

SessionPool(*, location: str, tags: Dict[str, str] | None = None, identity: _models.ManagedServiceIdentity | None = None, environment_id: str | None = None, container_type: str | _models.ContainerType | None = None, pool_management_type: str | _models.PoolManagementType | None = None, scale_configuration: _models.ScaleConfiguration | None = None, secrets: List[_models.SessionPoolSecret] | None = None, dynamic_pool_configuration: _models.DynamicPoolConfiguration | None = None, custom_container_template: _models.CustomContainerTemplate | None = None, session_network_configuration: _models.SessionNetworkConfiguration | None = None, managed_identity_settings: List[_models.ManagedIdentitySetting] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
tags
dict[str, str]

Resource tags.

Default value: None
location
str

The geo-location where the resource lives. Required.
identity
ManagedServiceIdentity

Managed identities needed by a session pool to interact with other Azure services to not maintain any secrets or credentials in code.

Default value: None
environment_id
str

Resource ID of the session pool's environment.

Default value: None
container_type
str or ContainerType

The container type of the sessions. Known values are: "CustomContainer" and "PythonLTS".

Default value: None
pool_management_type
str or PoolManagementType

The pool management type of the session pool. Known values are: "Manual" and "Dynamic".

Default value: None
scale_configuration
ScaleConfiguration

The scale configuration of the session pool.

Default value: None
secrets
list[SessionPoolSecret]

The secrets of the session pool.

Default value: None
dynamic_pool_configuration
DynamicPoolConfiguration

The pool configuration if the poolManagementType is dynamic.

Default value: None
custom_container_template
CustomContainerTemplate

The custom container configuration if the containerType is CustomContainer.

Default value: None
session_network_configuration
SessionNetworkConfiguration

The network configuration of the sessions in the session pool.

Default value: None
managed_identity_settings
list[ManagedIdentitySetting]

Optional settings for a Managed Identity that is assigned to the Session pool.

Default value: None

Variables

Name Description
id
str

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name
str

The name of the resource.
type
str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
system_data
SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags
dict[str, str]

Resource tags.
location
str

The geo-location where the resource lives. Required.
identity
ManagedServiceIdentity

Managed identities needed by a session pool to interact with other Azure services to not maintain any secrets or credentials in code.
environment_id
str

Resource ID of the session pool's environment.
container_type
str or ContainerType

The container type of the sessions. Known values are: "CustomContainer" and "PythonLTS".
pool_management_type
str or PoolManagementType

The pool management type of the session pool. Known values are: "Manual" and "Dynamic".
node_count
int

The number of nodes the session pool is using.
scale_configuration
ScaleConfiguration

The scale configuration of the session pool.
secrets
list[SessionPoolSecret]

The secrets of the session pool.
dynamic_pool_configuration
DynamicPoolConfiguration

The pool configuration if the poolManagementType is dynamic.
custom_container_template
CustomContainerTemplate

The custom container configuration if the containerType is CustomContainer.
session_network_configuration
SessionNetworkConfiguration

The network configuration of the sessions in the session pool.
pool_management_endpoint
str

The endpoint to manage the pool.
provisioning_state
str or SessionPoolProvisioningState

Provisioning state of the session pool. Known values are: "InProgress", "Succeeded", "Failed", "Canceled", and "Deleting".
managed_identity_settings
list[ManagedIdentitySetting]

Optional settings for a Managed Identity that is assigned to the Session pool.