session_pools

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

Overview

Name	session_pools
Type	Resource
Id	azure.container_apps.session_pools

Fields

The following fields are returned by SELECT queries:

get

OK.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Container App session pool resource specific properties
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Container App session pool resource specific properties
tags	object	Resource tags.

list_by_subscription

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Container App session pool resource specific properties
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, sessionPoolName
list_by_resource_group	select	subscriptionId, resourceGroupName
list_by_subscription	select	subscriptionId
create_or_update	insert	subscriptionId, resourceGroupName, sessionPoolName		Create or update a session pool with the given properties.
update	update	subscriptionId, resourceGroupName, sessionPoolName		Patches a session pool using JSON merge patch
delete	delete	subscriptionId, resourceGroupName, sessionPoolName		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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
sessionPoolName	string	Name of the session pool.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

OK.

SELECT
location,
properties,
tags
FROM azure.container_apps.session_pools
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND sessionPoolName = '{{ sessionPoolName }}' -- required
;

list_by_resource_group

OK

SELECT
location,
properties,
tags
FROM azure.container_apps.session_pools
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

OK

SELECT
location,
properties,
tags
FROM azure.container_apps.session_pools
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or update a session pool with the given properties.

INSERT INTO azure.container_apps.session_pools (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
sessionPoolName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ sessionPoolName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: session_pools
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the session_pools resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the session_pools resource.
    - name: sessionPoolName
      value: string
      description: Required parameter for the session_pools resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Container App session pool resource specific properties

UPDATE examples

update

Patches a session pool using JSON merge patch

UPDATE azure.container_apps.session_pools
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND sessionPoolName = '{{ sessionPoolName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Delete the session pool with the given name.

DELETE FROM azure.container_apps.session_pools
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND sessionPoolName = '{{ sessionPoolName }}' --required
;