Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. app
  5. getContainerAppsSessionPool
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.app.getContainerAppsSessionPool

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    Container App session pool. Azure REST API version: 2024-02-02-preview.

    Other available API versions: 2024-08-02-preview, 2024-10-02-preview.

    Using getContainerAppsSessionPool

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getContainerAppsSessionPool(args: GetContainerAppsSessionPoolArgs, opts?: InvokeOptions): Promise<GetContainerAppsSessionPoolResult>
function getContainerAppsSessionPoolOutput(args: GetContainerAppsSessionPoolOutputArgs, opts?: InvokeOptions): Output<GetContainerAppsSessionPoolResult>
    def get_container_apps_session_pool(resource_group_name: Optional[str] = None,
                                    session_pool_name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetContainerAppsSessionPoolResult
def get_container_apps_session_pool_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                    session_pool_name: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetContainerAppsSessionPoolResult]
    func LookupContainerAppsSessionPool(ctx *Context, args *LookupContainerAppsSessionPoolArgs, opts ...InvokeOption) (*LookupContainerAppsSessionPoolResult, error)
func LookupContainerAppsSessionPoolOutput(ctx *Context, args *LookupContainerAppsSessionPoolOutputArgs, opts ...InvokeOption) LookupContainerAppsSessionPoolResultOutput

    > Note: This function is named LookupContainerAppsSessionPool in the Go SDK.

    public static class GetContainerAppsSessionPool 
{
    public static Task<GetContainerAppsSessionPoolResult> InvokeAsync(GetContainerAppsSessionPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetContainerAppsSessionPoolResult> Invoke(GetContainerAppsSessionPoolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetContainerAppsSessionPoolResult> getContainerAppsSessionPool(GetContainerAppsSessionPoolArgs args, InvokeOptions options)
public static Output<GetContainerAppsSessionPoolResult> getContainerAppsSessionPool(GetContainerAppsSessionPoolArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:app:getContainerAppsSessionPool
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SessionPoolName string
    Name of the session pool.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SessionPoolName string
    Name of the session pool.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    sessionPoolName String
    Name of the session pool.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    sessionPoolName string
    Name of the session pool.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    session_pool_name str
    Name of the session pool.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    sessionPoolName String
    Name of the session pool.

    getContainerAppsSessionPool Result

    The following output properties are available:

    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    NodeCount int
    The number of nodes the session pool is using.
    PoolManagementEndpoint string
    The endpoint to manage the pool.
    ProvisioningState string
    Provisioning state of the session pool.
    SystemData Pulumi.AzureNative.App.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    ContainerType string
    The container type of the sessions.
    CustomContainerTemplate Pulumi.AzureNative.App.Outputs.CustomContainerTemplateResponse
    The custom container configuration if the containerType is CustomContainer.
    DynamicPoolConfiguration Pulumi.AzureNative.App.Outputs.DynamicPoolConfigurationResponse
    The pool configuration if the poolManagementType is dynamic.
    EnvironmentId string
    Resource ID of the session pool's environment.
    PoolManagementType string
    The pool management type of the session pool.
    ScaleConfiguration Pulumi.AzureNative.App.Outputs.ScaleConfigurationResponse
    The scale configuration of the session pool.
    Secrets List<Pulumi.AzureNative.App.Outputs.SessionPoolSecretResponse>
    The secrets of the session pool.
    SessionNetworkConfiguration Pulumi.AzureNative.App.Outputs.SessionNetworkConfigurationResponse
    The network configuration of the sessions in the session pool.
    Tags Dictionary<string, string>
    Resource tags.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    NodeCount int
    The number of nodes the session pool is using.
    PoolManagementEndpoint string
    The endpoint to manage the pool.
    ProvisioningState string
    Provisioning state of the session pool.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    ContainerType string
    The container type of the sessions.
    CustomContainerTemplate CustomContainerTemplateResponse
    The custom container configuration if the containerType is CustomContainer.
    DynamicPoolConfiguration DynamicPoolConfigurationResponse
    The pool configuration if the poolManagementType is dynamic.
    EnvironmentId string
    Resource ID of the session pool's environment.
    PoolManagementType string
    The pool management type of the session pool.
    ScaleConfiguration ScaleConfigurationResponse
    The scale configuration of the session pool.
    Secrets []SessionPoolSecretResponse
    The secrets of the session pool.
    SessionNetworkConfiguration SessionNetworkConfigurationResponse
    The network configuration of the sessions in the session pool.
    Tags map[string]string
    Resource tags.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    nodeCount Integer
    The number of nodes the session pool is using.
    poolManagementEndpoint String
    The endpoint to manage the pool.
    provisioningState String
    Provisioning state of the session pool.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    containerType String
    The container type of the sessions.
    customContainerTemplate CustomContainerTemplateResponse
    The custom container configuration if the containerType is CustomContainer.
    dynamicPoolConfiguration DynamicPoolConfigurationResponse
    The pool configuration if the poolManagementType is dynamic.
    environmentId String
    Resource ID of the session pool's environment.
    poolManagementType String
    The pool management type of the session pool.
    scaleConfiguration ScaleConfigurationResponse
    The scale configuration of the session pool.
    secrets List<SessionPoolSecretResponse>
    The secrets of the session pool.
    sessionNetworkConfiguration SessionNetworkConfigurationResponse
    The network configuration of the sessions in the session pool.
    tags Map<String,String>
    Resource tags.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    nodeCount number
    The number of nodes the session pool is using.
    poolManagementEndpoint string
    The endpoint to manage the pool.
    provisioningState string
    Provisioning state of the session pool.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    containerType string
    The container type of the sessions.
    customContainerTemplate CustomContainerTemplateResponse
    The custom container configuration if the containerType is CustomContainer.
    dynamicPoolConfiguration DynamicPoolConfigurationResponse
    The pool configuration if the poolManagementType is dynamic.
    environmentId string
    Resource ID of the session pool's environment.
    poolManagementType string
    The pool management type of the session pool.
    scaleConfiguration ScaleConfigurationResponse
    The scale configuration of the session pool.
    secrets SessionPoolSecretResponse[]
    The secrets of the session pool.
    sessionNetworkConfiguration SessionNetworkConfigurationResponse
    The network configuration of the sessions in the session pool.
    tags {[key: string]: string}
    Resource tags.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    node_count int
    The number of nodes the session pool is using.
    pool_management_endpoint str
    The endpoint to manage the pool.
    provisioning_state str
    Provisioning state of the session pool.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    container_type str
    The container type of the sessions.
    custom_container_template CustomContainerTemplateResponse
    The custom container configuration if the containerType is CustomContainer.
    dynamic_pool_configuration DynamicPoolConfigurationResponse
    The pool configuration if the poolManagementType is dynamic.
    environment_id str
    Resource ID of the session pool's environment.
    pool_management_type str
    The pool management type of the session pool.
    scale_configuration ScaleConfigurationResponse
    The scale configuration of the session pool.
    secrets Sequence[SessionPoolSecretResponse]
    The secrets of the session pool.
    session_network_configuration SessionNetworkConfigurationResponse
    The network configuration of the sessions in the session pool.
    tags Mapping[str, str]
    Resource tags.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    nodeCount Number
    The number of nodes the session pool is using.
    poolManagementEndpoint String
    The endpoint to manage the pool.
    provisioningState String
    Provisioning state of the session pool.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    containerType String
    The container type of the sessions.
    customContainerTemplate Property Map
    The custom container configuration if the containerType is CustomContainer.
    dynamicPoolConfiguration Property Map
    The pool configuration if the poolManagementType is dynamic.
    environmentId String
    Resource ID of the session pool's environment.
    poolManagementType String
    The pool management type of the session pool.
    scaleConfiguration Property Map
    The scale configuration of the session pool.
    secrets List<Property Map>
    The secrets of the session pool.
    sessionNetworkConfiguration Property Map
    The network configuration of the sessions in the session pool.
    tags Map<String>
    Resource tags.

    Supporting Types

    CustomContainerTemplateResponse

    Containers List<Pulumi.AzureNative.App.Inputs.SessionContainerResponse>
    List of container definitions for the sessions of the session pool.
    Ingress Pulumi.AzureNative.App.Inputs.SessionIngressResponse
    Session pool ingress configuration.
    RegistryCredentials Pulumi.AzureNative.App.Inputs.SessionRegistryCredentialsResponse
    Private container registry credentials for containers used by the sessions of the session pool.
    Containers []SessionContainerResponse
    List of container definitions for the sessions of the session pool.
    Ingress SessionIngressResponse
    Session pool ingress configuration.
    RegistryCredentials SessionRegistryCredentialsResponse
    Private container registry credentials for containers used by the sessions of the session pool.
    containers List<SessionContainerResponse>
    List of container definitions for the sessions of the session pool.
    ingress SessionIngressResponse
    Session pool ingress configuration.
    registryCredentials SessionRegistryCredentialsResponse
    Private container registry credentials for containers used by the sessions of the session pool.
    containers SessionContainerResponse[]
    List of container definitions for the sessions of the session pool.
    ingress SessionIngressResponse
    Session pool ingress configuration.
    registryCredentials SessionRegistryCredentialsResponse
    Private container registry credentials for containers used by the sessions of the session pool.
    containers Sequence[SessionContainerResponse]
    List of container definitions for the sessions of the session pool.
    ingress SessionIngressResponse
    Session pool ingress configuration.
    registry_credentials SessionRegistryCredentialsResponse
    Private container registry credentials for containers used by the sessions of the session pool.
    containers List<Property Map>
    List of container definitions for the sessions of the session pool.
    ingress Property Map
    Session pool ingress configuration.
    registryCredentials Property Map
    Private container registry credentials for containers used by the sessions of the session pool.

    DynamicPoolConfigurationResponse

    CooldownPeriodInSeconds int
    The cooldown period of a session in seconds.
    ExecutionType string
    The execution type of the session pool.
    CooldownPeriodInSeconds int
    The cooldown period of a session in seconds.
    ExecutionType string
    The execution type of the session pool.
    cooldownPeriodInSeconds Integer
    The cooldown period of a session in seconds.
    executionType String
    The execution type of the session pool.
    cooldownPeriodInSeconds number
    The cooldown period of a session in seconds.
    executionType string
    The execution type of the session pool.
    cooldown_period_in_seconds int
    The cooldown period of a session in seconds.
    execution_type str
    The execution type of the session pool.
    cooldownPeriodInSeconds Number
    The cooldown period of a session in seconds.
    executionType String
    The execution type of the session pool.

    EnvironmentVarResponse

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

    ScaleConfigurationResponse

    MaxConcurrentSessions int
    The maximum count of sessions at the same time.
    ReadySessionInstances int
    The minimum count of ready session instances.
    MaxConcurrentSessions int
    The maximum count of sessions at the same time.
    ReadySessionInstances int
    The minimum count of ready session instances.
    maxConcurrentSessions Integer
    The maximum count of sessions at the same time.
    readySessionInstances Integer
    The minimum count of ready session instances.
    maxConcurrentSessions number
    The maximum count of sessions at the same time.
    readySessionInstances number
    The minimum count of ready session instances.
    max_concurrent_sessions int
    The maximum count of sessions at the same time.
    ready_session_instances int
    The minimum count of ready session instances.
    maxConcurrentSessions Number
    The maximum count of sessions at the same time.
    readySessionInstances Number
    The minimum count of ready session instances.

    SessionContainerResourcesResponse

    Cpu double
    Required CPU in cores, e.g. 0.5
    Memory string
    Required memory, e.g. "250Mb"
    Cpu float64
    Required CPU in cores, e.g. 0.5
    Memory string
    Required memory, e.g. "250Mb"
    cpu Double
    Required CPU in cores, e.g. 0.5
    memory String
    Required memory, e.g. "250Mb"
    cpu number
    Required CPU in cores, e.g. 0.5
    memory string
    Required memory, e.g. "250Mb"
    cpu float
    Required CPU in cores, e.g. 0.5
    memory str
    Required memory, e.g. "250Mb"
    cpu Number
    Required CPU in cores, e.g. 0.5
    memory String
    Required memory, e.g. "250Mb"

    SessionContainerResponse

    Args List<string>
    Container start command arguments.
    Command List<string>
    Container start command.
    Env List<Pulumi.AzureNative.App.Inputs.EnvironmentVarResponse>
    Container environment variables.
    Image string
    Container image tag.
    Name string
    Custom container name.
    Resources Pulumi.AzureNative.App.Inputs.SessionContainerResourcesResponse
    Container resource requirements.
    Args []string
    Container start command arguments.
    Command []string
    Container start command.
    Env []EnvironmentVarResponse
    Container environment variables.
    Image string
    Container image tag.
    Name string
    Custom container name.
    Resources SessionContainerResourcesResponse
    Container resource requirements.
    args List<String>
    Container start command arguments.
    command List<String>
    Container start command.
    env List<EnvironmentVarResponse>
    Container environment variables.
    image String
    Container image tag.
    name String
    Custom container name.
    resources SessionContainerResourcesResponse
    Container resource requirements.
    args string[]
    Container start command arguments.
    command string[]
    Container start command.
    env EnvironmentVarResponse[]
    Container environment variables.
    image string
    Container image tag.
    name string
    Custom container name.
    resources SessionContainerResourcesResponse
    Container resource requirements.
    args Sequence[str]
    Container start command arguments.
    command Sequence[str]
    Container start command.
    env Sequence[EnvironmentVarResponse]
    Container environment variables.
    image str
    Container image tag.
    name str
    Custom container name.
    resources SessionContainerResourcesResponse
    Container resource requirements.
    args List<String>
    Container start command arguments.
    command List<String>
    Container start command.
    env List<Property Map>
    Container environment variables.
    image String
    Container image tag.
    name String
    Custom container name.
    resources Property Map
    Container resource requirements.

    SessionIngressResponse

    TargetPort int
    Target port in containers for traffic from ingress
    TargetPort int
    Target port in containers for traffic from ingress
    targetPort Integer
    Target port in containers for traffic from ingress
    targetPort number
    Target port in containers for traffic from ingress
    target_port int
    Target port in containers for traffic from ingress
    targetPort Number
    Target port in containers for traffic from ingress

    SessionNetworkConfigurationResponse

    Status string
    Network status for the sessions.
    Status string
    Network status for the sessions.
    status String
    Network status for the sessions.
    status string
    Network status for the sessions.
    status str
    Network status for the sessions.
    status String
    Network status for the sessions.

    SessionPoolSecretResponse

    Name string
    Secret Name.
    Name string
    Secret Name.
    name String
    Secret Name.
    name string
    Secret Name.
    name str
    Secret Name.
    name String
    Secret Name.

    SessionRegistryCredentialsResponse

    PasswordSecretRef string
    The name of the secret that contains the registry login password
    RegistryServer string
    Container registry server.
    Username string
    Container registry username.
    PasswordSecretRef string
    The name of the secret that contains the registry login password
    RegistryServer string
    Container registry server.
    Username string
    Container registry username.
    passwordSecretRef String
    The name of the secret that contains the registry login password
    registryServer String
    Container registry server.
    username String
    Container registry username.
    passwordSecretRef string
    The name of the secret that contains the registry login password
    registryServer string
    Container registry server.
    username string
    Container registry username.
    password_secret_ref str
    The name of the secret that contains the registry login password
    registry_server str
    Container registry server.
    username str
    Container registry username.
    passwordSecretRef String
    The name of the secret that contains the registry login password
    registryServer String
    Container registry server.
    username String
    Container registry username.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native