Container Apps Session Pools - Get

サービス:

Azure Container Apps

API バージョン:

2025-01-01

セッション プールのプロパティを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/sessionPools/{sessionPoolName}?api-version=2025-01-01

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前では大文字と小文字が区別されません。
sessionPoolName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z][a-z0-9]*$	セッション プールの名前。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	SessionPool	わかりました。
Other Status Codes	ErrorResponse	一般的なエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

Get Session Pool

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/sessionPools/testsessionpool?api-version=2025-01-01

Java

/**
 * Samples for ContainerAppsSessionPools GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/app/resource-manager/Microsoft.App/stable/2025-01-01/examples/SessionPools_Get.json
     */
    /**
     * Sample code: Get Session Pool.
     * 
     * @param manager Entry point to ContainerAppsApiManager.
     */
    public static void getSessionPool(com.azure.resourcemanager.appcontainers.ContainerAppsApiManager manager) {
        manager.containerAppsSessionPools().getByResourceGroupWithResponse("rg", "testsessionpool",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.appcontainers import ContainerAppsAPIClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appcontainers
# USAGE
    python session_pools_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ContainerAppsAPIClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.container_apps_session_pools.get(
        resource_group_name="rg",
        session_pool_name="testsessionpool",
    )
    print(response)


# x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2025-01-01/examples/SessionPools_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armappcontainers_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/8eb3f7a4f66d408152c32b9d647e59147172d533/specification/app/resource-manager/Microsoft.App/stable/2025-01-01/examples/SessionPools_Get.json
func ExampleContainerAppsSessionPoolsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewContainerAppsSessionPoolsClient().Get(ctx, "rg", "testsessionpool", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SessionPool = armappcontainers.SessionPool{
	// 	Name: to.Ptr("testsessionpool"),
	// 	Type: to.Ptr("Microsoft.App/sessionPools"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/sessionPools/testsessionpool"),
	// 	Location: to.Ptr("East US"),
	// 	Identity: &armappcontainers.ManagedServiceIdentity{
	// 		Type: to.Ptr(armappcontainers.ManagedServiceIdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("bce8c037-3d10-44a4-a970-25f799611fc6"),
	// 		TenantID: to.Ptr("72f988bf-86f1-41af-91ab-2d7cd011db47"),
	// 	},
	// 	Properties: &armappcontainers.SessionPoolProperties{
	// 		ContainerType: to.Ptr(armappcontainers.ContainerTypeCustomContainer),
	// 		CustomContainerTemplate: &armappcontainers.CustomContainerTemplate{
	// 			Containers: []*armappcontainers.SessionContainer{
	// 				{
	// 					Name: to.Ptr("testinitcontainer"),
	// 					Args: []*string{
	// 						to.Ptr("-c"),
	// 						to.Ptr("while true; do echo hello; sleep 10;done")},
	// 						Command: []*string{
	// 							to.Ptr("/bin/sh")},
	// 							Image: to.Ptr("repo/testcontainer:v4"),
	// 							Resources: &armappcontainers.SessionContainerResources{
	// 								CPU: to.Ptr[float64](0.25),
	// 								Memory: to.Ptr("0.5Gi"),
	// 							},
	// 					}},
	// 					Ingress: &armappcontainers.SessionIngress{
	// 						TargetPort: to.Ptr[int32](80),
	// 					},
	// 					RegistryCredentials: &armappcontainers.SessionRegistryCredentials{
	// 						Identity: to.Ptr("/subscriptions/7a497526-bb8d-4816-9795-db1418a1f977/resourcegroups/test/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testSP"),
	// 						Server: to.Ptr("test.azurecr.io"),
	// 					},
	// 				},
	// 				DynamicPoolConfiguration: &armappcontainers.DynamicPoolConfiguration{
	// 					LifecycleConfiguration: &armappcontainers.LifecycleConfiguration{
	// 						CooldownPeriodInSeconds: to.Ptr[int32](600),
	// 						LifecycleType: to.Ptr(armappcontainers.LifecycleTypeTimed),
	// 					},
	// 				},
	// 				EnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
	// 				ManagedIdentitySettings: []*armappcontainers.ManagedIdentitySetting{
	// 					{
	// 						Identity: to.Ptr("system"),
	// 						Lifecycle: to.Ptr(armappcontainers.IdentitySettingsLifeCycleMain),
	// 				}},
	// 				NodeCount: to.Ptr[int32](1),
	// 				PoolManagementEndpoint: to.Ptr("https://testsessionpool.agreeableriver-3d30edf1.eastus.azurecontainerapps.io"),
	// 				PoolManagementType: to.Ptr(armappcontainers.PoolManagementTypeDynamic),
	// 				ProvisioningState: to.Ptr(armappcontainers.SessionPoolProvisioningStateSucceeded),
	// 				ScaleConfiguration: &armappcontainers.ScaleConfiguration{
	// 					MaxConcurrentSessions: to.Ptr[int32](500),
	// 					ReadySessionInstances: to.Ptr[int32](100),
	// 				},
	// 				SessionNetworkConfiguration: &armappcontainers.SessionNetworkConfiguration{
	// 					Status: to.Ptr(armappcontainers.SessionNetworkStatusEgressEnabled),
	// 				},
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ContainerAppsAPIClient } = require("@azure/arm-appcontainers");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Get the properties of a session pool.
 *
 * @summary Get the properties of a session pool.
 * x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2025-01-01/examples/SessionPools_Get.json
 */
async function getSessionPool() {
  const subscriptionId =
    process.env["APPCONTAINERS_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPCONTAINERS_RESOURCE_GROUP"] || "rg";
  const sessionPoolName = "testsessionpool";
  const credential = new DefaultAzureCredential();
  const client = new ContainerAppsAPIClient(credential, subscriptionId);
  const result = await client.containerAppsSessionPools.get(resourceGroupName, sessionPoolName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppContainers.Models;
using Azure.ResourceManager.AppContainers;

// Generated from example definition: specification/app/resource-manager/Microsoft.App/stable/2025-01-01/examples/SessionPools_Get.json
// this example is just showing the usage of "ContainerAppsSessionPools_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SessionPoolResource created on azure
// for more information of creating SessionPoolResource, please refer to the document of SessionPoolResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "rg";
string sessionPoolName = "testsessionpool";
ResourceIdentifier sessionPoolResourceId = SessionPoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, sessionPoolName);
SessionPoolResource sessionPool = client.GetSessionPoolResource(sessionPoolResourceId);

// invoke the operation
SessionPoolResource result = await sessionPool.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SessionPoolData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/sessionPools/testsessionpool",
  "name": "testsessionpool",
  "type": "Microsoft.App/sessionPools",
  "location": "East US",
  "properties": {
    "provisioningState": "Succeeded",
    "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube",
    "poolManagementType": "Dynamic",
    "containerType": "CustomContainer",
    "nodeCount": 1,
    "scaleConfiguration": {
      "maxConcurrentSessions": 500,
      "readySessionInstances": 100
    },
    "dynamicPoolConfiguration": {
      "lifecycleConfiguration": {
        "lifecycleType": "Timed",
        "cooldownPeriodInSeconds": 600
      }
    },
    "customContainerTemplate": {
      "containers": [
        {
          "image": "repo/testcontainer:v4",
          "name": "testinitcontainer",
          "resources": {
            "cpu": 0.25,
            "memory": "0.5Gi"
          },
          "command": [
            "/bin/sh"
          ],
          "args": [
            "-c",
            "while true; do echo hello; sleep 10;done"
          ]
        }
      ],
      "ingress": {
        "targetPort": 80
      },
      "registryCredentials": {
        "server": "test.azurecr.io",
        "identity": "/subscriptions/7a497526-bb8d-4816-9795-db1418a1f977/resourcegroups/test/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testSP"
      }
    },
    "sessionNetworkConfiguration": {
      "status": "EgressEnabled"
    },
    "managedIdentitySettings": [
      {
        "identity": "system",
        "lifecycle": "Main"
      }
    ],
    "poolManagementEndpoint": "https://testsessionpool.agreeableriver-3d30edf1.eastus.azurecontainerapps.io"
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "bce8c037-3d10-44a4-a970-25f799611fc6",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
  }
}

定義

名前	説明
ContainerType	セッションのコンテナーの種類。
createdByType	リソースを作成した ID の種類。
CustomContainerTemplate	カスタム コンテナーの構成。
DynamicPoolConfiguration	動的プールの構成。
EnvironmentVar	Container App コンテナー環境変数。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
IdentitySettingsLifeCycle	マネージド ID を使用できるセッション プールのライフサイクル ステージを選択するために使用します。
LifecycleConfiguration	動的セッション プール内のセッションのライフサイクル構成プロパティ
LifecycleType	セッション プールのライフサイクルの種類。
ManagedIdentitySetting	セッション プールに割り当てられているマネージド ID のオプション設定。
ManagedServiceIdentity	マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID)
ManagedServiceIdentityType	マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
PoolManagementType	セッション プールのプール管理の種類。
ScaleConfiguration	スケール構成。
SessionContainer	セッション プールのセッションのコンテナー定義。
SessionContainerResources	セッション プールのセッションのコンテナー リソース要件。
SessionIngress	セッション プールのイングレス構成。
SessionNetworkConfiguration	セッション ネットワークの構成。
SessionNetworkStatus	セッションのネットワーク状態。
SessionPool	コンテナー アプリ セッション プール。
SessionPoolProvisioningState	セッション プールのプロビジョニング状態。
SessionPoolSecret	シークレット定義。
SessionRegistryCredentials	セッション プールのプライベート レジストリ資格情報。
systemData	リソースの作成と最後の変更に関連するメタデータ。
UserAssignedIdentity	ユーザー割り当て ID プロパティ

ContainerType

列挙

セッションのコンテナーの種類。

値	説明
CustomContainer
PythonLTS

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

CustomContainerTemplate

Object

カスタム コンテナーの構成。

名前	型	説明
containers	SessionContainer[]	セッション プールのセッションのコンテナー定義の一覧。
ingress	SessionIngress	セッション プールのイングレス構成。
registryCredentials	SessionRegistryCredentials	セッション プールのセッションで使用されるコンテナーのプライベート コンテナー レジストリ資格情報。

DynamicPoolConfiguration

Object

動的プールの構成。

名前	型	説明
lifecycleConfiguration	LifecycleConfiguration	動的セッション プール内のセッションのライフサイクル構成

EnvironmentVar

Object

Container App コンテナー環境変数。

名前	型	説明
name	string	環境変数の名前。
secretRef	string	環境変数の値をプルするコンテナー アプリ シークレットの名前。
value	string	シークレット以外の環境変数の値。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

IdentitySettingsLifeCycle

列挙

マネージド ID を使用できるセッション プールのライフサイクル ステージを選択するために使用します。

値	説明
Main
None

LifecycleConfiguration

Object

動的セッション プール内のセッションのライフサイクル構成プロパティ

名前	型	説明
cooldownPeriodInSeconds	integer (int32)	ライフサイクルの種類が "Timed" の場合のセッションのクールダウン期間 (秒単位)。
lifecycleType	LifecycleType	セッション プールのライフサイクルの種類。
maxAlivePeriodInSeconds	integer (int32)	ライフサイクルの種類が "OnContainerExit" の場合のセッションの最大有効期間 (秒単位)。

LifecycleType

列挙

セッション プールのライフサイクルの種類。

値	説明
OnContainerExit
Timed

ManagedIdentitySetting

Object

セッション プールに割り当てられているマネージド ID のオプション設定。

名前	型	規定値	説明
identity	string		セッション プールに割り当てられているユーザー割り当てマネージド ID のリソース ID。システム割り当て ID の場合は "system" です。
lifecycle	IdentitySettingsLifeCycle	None	マネージド ID を使用できるセッション プールのライフサイクル ステージを選択するために使用します。

ManagedServiceIdentity

Object

マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID)

名前	型	説明
principalId	string (uuid)	システム割り当て ID のサービス プリンシパル ID。 このプロパティは、システム割り当て ID にのみ提供されます。
tenantId	string (uuid)	システム割り当て ID のテナント ID。 このプロパティは、システム割り当て ID にのみ提供されます。
type	ManagedServiceIdentityType	マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned ID リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。

ManagedServiceIdentityType

列挙

マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。

値	説明
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

PoolManagementType

列挙

セッション プールのプール管理の種類。

値	説明
Dynamic
Manual

ScaleConfiguration

Object

スケール構成。

名前	型	説明
maxConcurrentSessions	integer (int32)	同時に行うセッションの最大数。
readySessionInstances	integer (int32)	準備完了セッション インスタンスの最小数。

SessionContainer

Object

セッション プールのセッションのコンテナー定義。

名前	型	説明
args	string[]	コンテナーの開始コマンド引数。
command	string[]	コンテナーの開始コマンド。
env	EnvironmentVar[]	コンテナー環境変数。
image	string	コンテナー イメージ タグ。
name	string	カスタム コンテナー名。
resources	SessionContainerResources	コンテナー リソースの要件。

SessionContainerResources

Object

セッション プールのセッションのコンテナー リソース要件。

名前	型	説明
cpu	number (double)	コアで必要な CPU (例: 0.5)
memory	string	必要なメモリ (例: "250Mb" )

SessionIngress

Object

セッション プールのイングレス構成。

名前	型	説明
targetPort	integer (int32)	イングレスからのトラフィックのコンテナー内のターゲット ポート

SessionNetworkConfiguration

Object

セッション ネットワークの構成。

名前	型	説明
status	SessionNetworkStatus	セッションのネットワーク状態。

SessionNetworkStatus

列挙

セッションのネットワーク状態。

値	説明
EgressDisabled
EgressEnabled

SessionPool

Object

コンテナー アプリ セッション プール。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	コード内のシークレットや資格情報を保持しないように、他の Azure サービスと対話するためにセッション プールで必要なマネージド ID。
location	string	リソースが存在する地理的な場所
name	string	リソースの名前
properties.containerType	ContainerType	セッションのコンテナーの種類。
properties.customContainerTemplate	CustomContainerTemplate	containerType が CustomContainer の場合のカスタム コンテナー構成。
properties.dynamicPoolConfiguration	DynamicPoolConfiguration	poolManagementType が動的な場合のプール構成。
properties.environmentId	string (arm-id)	セッション プールの環境のリソース ID。
properties.managedIdentitySettings	ManagedIdentitySetting[]	セッション プールに割り当てられているマネージド ID のオプション設定。
properties.nodeCount	integer (int32)	セッション プールが使用しているノードの数。
properties.poolManagementEndpoint	string (uri)	プールを管理するエンドポイント。
properties.poolManagementType	PoolManagementType	セッション プールのプール管理の種類。
properties.provisioningState	SessionPoolProvisioningState	セッション プールのプロビジョニング状態。
properties.scaleConfiguration	ScaleConfiguration	セッション プールのスケール構成。
properties.secrets	SessionPoolSecret[]	セッション プールのシークレット。
properties.sessionNetworkConfiguration	SessionNetworkConfiguration	セッション プール内のセッションのネットワーク構成。
systemData	systemData	createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソース タグ。
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

SessionPoolProvisioningState

列挙

セッション プールのプロビジョニング状態。

値	説明
Canceled
Deleting
Failed
InProgress
Succeeded

SessionPoolSecret

Object

シークレット定義。

名前	型	説明
name	string	シークレット名。
value	string	シークレット値。

SessionRegistryCredentials

Object

セッション プールのプライベート レジストリ資格情報。

名前	型	説明
identity	string	Azure Container Registry での認証に使用するマネージド ID。 ユーザー割り当て ID の場合は、完全なユーザー割り当て ID リソース ID を使用します。 システム割り当て ID の場合は、'system' を使用します
passwordSecretRef	string	レジストリ ログイン パスワードを含むシークレットの名前
server	string	コンテナー レジストリ サーバー。
username	string	コンテナー レジストリのユーザー名。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

UserAssignedIdentity

Object

ユーザー割り当て ID プロパティ

名前	型	説明
clientId	string (uuid)	割り当てられた ID のクライアント ID。
principalId	string (uuid)	割り当てられた ID のプリンシパル ID。