container_apps_session_pools

Creates, updates, deletes, gets or lists a container_apps_session_pools resource.

Overview

Name	container_apps_session_pools
Type	Resource
Id	azure.app_containers.container_apps_session_pools

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
containerType	string	The container type of the sessions. You can use your own container to build the session pool, or you can use a predefined container to run workload with specific language. Known values are: "CustomContainer" and "PythonLTS". (CustomContainer, PythonLTS)
customContainerTemplate	object	The custom container configuration if the containerType is CustomContainer.
dynamicPoolConfiguration	object	The pool configuration if the poolManagementType is dynamic.
environmentId	string	Resource ID of the session pool's environment.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
managedIdentitySettings	array	Optional settings for a Managed Identity that is assigned to the Session pool.
nodeCount	integer	The number of nodes the session pool is using.
poolManagementEndpoint	string	The endpoint to manage the pool.
poolManagementType	string	The pool management type of the session pool. Known values are: "Manual" and "Dynamic". (Manual, Dynamic)
provisioningState	string	Provisioning state of the session pool. Known values are: "InProgress", "Succeeded", "Failed", "Canceled", and "Deleting". (InProgress, Succeeded, Failed, Canceled, Deleting)
scaleConfiguration	object	The scale configuration of the session pool.
secrets	array	The secrets of the session pool.
sessionNetworkConfiguration	object	The network configuration of the sessions in the session pool.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
containerType	string	The container type of the sessions. You can use your own container to build the session pool, or you can use a predefined container to run workload with specific language. Known values are: "CustomContainer" and "PythonLTS". (CustomContainer, PythonLTS)
customContainerTemplate	object	The custom container configuration if the containerType is CustomContainer.
dynamicPoolConfiguration	object	The pool configuration if the poolManagementType is dynamic.
environmentId	string	Resource ID of the session pool's environment.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
managedIdentitySettings	array	Optional settings for a Managed Identity that is assigned to the Session pool.
nodeCount	integer	The number of nodes the session pool is using.
poolManagementEndpoint	string	The endpoint to manage the pool.
poolManagementType	string	The pool management type of the session pool. Known values are: "Manual" and "Dynamic". (Manual, Dynamic)
provisioningState	string	Provisioning state of the session pool. Known values are: "InProgress", "Succeeded", "Failed", "Canceled", and "Deleting". (InProgress, Succeeded, Failed, Canceled, Deleting)
scaleConfiguration	object	The scale configuration of the session pool.
secrets	array	The secrets of the session pool.
sessionNetworkConfiguration	object	The network configuration of the sessions in the session pool.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
containerType	string	The container type of the sessions. You can use your own container to build the session pool, or you can use a predefined container to run workload with specific language. Known values are: "CustomContainer" and "PythonLTS". (CustomContainer, PythonLTS)
customContainerTemplate	object	The custom container configuration if the containerType is CustomContainer.
dynamicPoolConfiguration	object	The pool configuration if the poolManagementType is dynamic.
environmentId	string	Resource ID of the session pool's environment.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
managedIdentitySettings	array	Optional settings for a Managed Identity that is assigned to the Session pool.
nodeCount	integer	The number of nodes the session pool is using.
poolManagementEndpoint	string	The endpoint to manage the pool.
poolManagementType	string	The pool management type of the session pool. Known values are: "Manual" and "Dynamic". (Manual, Dynamic)
provisioningState	string	Provisioning state of the session pool. Known values are: "InProgress", "Succeeded", "Failed", "Canceled", and "Deleting". (InProgress, Succeeded, Failed, Canceled, Deleting)
scaleConfiguration	object	The scale configuration of the session pool.
secrets	array	The secrets of the session pool.
sessionNetworkConfiguration	object	The network configuration of the sessions in the session pool.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, session_pool_name, subscription_id		Get the properties of a session pool. Get the properties of a session pool.
list_by_resource_group	select	resource_group_name, subscription_id		Get the session pools in a given resource group of a subscription. Get the session pools in a given resource group of a subscription.
list_by_subscription	select	subscription_id		Get the session pools in a given subscription. Get the session pools in a given subscription.
create_or_update	insert	resource_group_name, session_pool_name, subscription_id, location		Create or update a session pool. Create or update a session pool with the given properties.
update	update	resource_group_name, session_pool_name, subscription_id		Update properties of a session pool. Patches a session pool using JSON merge patch.
create_or_update	replace	resource_group_name, session_pool_name, subscription_id, location		Create or update a session pool. Create or update a session pool with the given properties.
delete	delete	resource_group_name, session_pool_name, subscription_id		Delete a session pool. Delete the session pool with the given name.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
session_pool_name	string	Name of the session pool. Required.
subscription_id	string

SELECT examples

get

Get the properties of a session pool. Get the properties of a session pool.

SELECT
id,
name,
containerType,
customContainerTemplate,
dynamicPoolConfiguration,
environmentId,
identity,
location,
managedIdentitySettings,
nodeCount,
poolManagementEndpoint,
poolManagementType,
provisioningState,
scaleConfiguration,
secrets,
sessionNetworkConfiguration,
systemData,
tags,
type
FROM azure.app_containers.container_apps_session_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND session_pool_name = '{{ session_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get the session pools in a given resource group of a subscription. Get the session pools in a given resource group of a subscription.

SELECT
id,
name,
containerType,
customContainerTemplate,
dynamicPoolConfiguration,
environmentId,
identity,
location,
managedIdentitySettings,
nodeCount,
poolManagementEndpoint,
poolManagementType,
provisioningState,
scaleConfiguration,
secrets,
sessionNetworkConfiguration,
systemData,
tags,
type
FROM azure.app_containers.container_apps_session_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Get the session pools in a given subscription. Get the session pools in a given subscription.

SELECT
id,
name,
containerType,
customContainerTemplate,
dynamicPoolConfiguration,
environmentId,
identity,
location,
managedIdentitySettings,
nodeCount,
poolManagementEndpoint,
poolManagementType,
provisioningState,
scaleConfiguration,
secrets,
sessionNetworkConfiguration,
systemData,
tags,
type
FROM azure.app_containers.container_apps_session_pools
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a session pool. Create or update a session pool with the given properties.

INSERT INTO azure.app_containers.container_apps_session_pools (
tags,
location,
properties,
identity,
resource_group_name,
session_pool_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ session_pool_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: container_apps_session_pools
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the container_apps_session_pools resource.
  - name: session_pool_name
    value: "{{ session_pool_name }}"
    description: Required parameter for the container_apps_session_pools resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the container_apps_session_pools resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Container App session pool resource specific properties.
    value:
      environmentId: "{{ environmentId }}"
      containerType: "{{ containerType }}"
      poolManagementType: "{{ poolManagementType }}"
      nodeCount: {{ nodeCount }}
      scaleConfiguration:
        maxConcurrentSessions: {{ maxConcurrentSessions }}
        readySessionInstances: {{ readySessionInstances }}
      secrets:
        - name: "{{ name }}"
          value: "{{ value }}"
      dynamicPoolConfiguration:
        lifecycleConfiguration:
          lifecycleType: "{{ lifecycleType }}"
          cooldownPeriodInSeconds: {{ cooldownPeriodInSeconds }}
          maxAlivePeriodInSeconds: {{ maxAlivePeriodInSeconds }}
      customContainerTemplate:
        registryCredentials:
          server: "{{ server }}"
          username: "{{ username }}"
          passwordSecretRef: "{{ passwordSecretRef }}"
          identity: "{{ identity }}"
        containers:
          - image: "{{ image }}"
            name: "{{ name }}"
            command: "{{ command }}"
            args: "{{ args }}"
            env: "{{ env }}"
            resources:
              cpu: {{ cpu }}
              memory: "{{ memory }}"
        ingress:
          targetPort: {{ targetPort }}
      sessionNetworkConfiguration:
        status: "{{ status }}"
      poolManagementEndpoint: "{{ poolManagementEndpoint }}"
      provisioningState: "{{ provisioningState }}"
      managedIdentitySettings:
        - identity: "{{ identity }}"
          lifecycle: "{{ lifecycle }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update properties of a session pool. Patches a session pool using JSON merge patch.

UPDATE azure.app_containers.container_apps_session_pools
SET 
tags = '{{ tags }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND session_pool_name = '{{ session_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update a session pool. Create or update a session pool with the given properties.

REPLACE azure.app_containers.container_apps_session_pools
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND session_pool_name = '{{ session_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a session pool. Delete the session pool with the given name.

DELETE FROM azure.app_containers.container_apps_session_pools
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND session_pool_name = '{{ session_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;