az containerapp sessionpool

Note

このリファレンスは、Azure CLI (バージョン 2.62.0 以降) の containerapp 拡張機能の一部です。 拡張機能は、 az containerapp sessionpool コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

セッション プールを管理するコマンド。

コマンド

名前	説明	型	状態
az containerapp sessionpool create	セッション プールを作成または更新します。	拡張子	ジョージア 州
az containerapp sessionpool delete	セッション プールを削除します。	拡張子	ジョージア 州
az containerapp sessionpool list	サブスクリプションまたはリソース グループ別にセッション プールを一覧表示します。	拡張子	ジョージア 州
az containerapp sessionpool show	セッション プールの詳細を表示します。	拡張子	ジョージア 州
az containerapp sessionpool update	セッション プールを更新します。	拡張子	ジョージア 州

az containerapp sessionpool create

セッション プールを作成または更新します。

az containerapp sessionpool create --name
                                   --resource-group
                                   [--args]
                                   [--command]
                                   [--container-name]
                                   [--container-type {CustomContainer, NodeLTS, PythonLTS}]
                                   [--cooldown-period]
                                   [--cpu]
                                   [--env-vars]
                                   [--environment]
                                   [--image]
                                   [--location]
                                   [--max-sessions]
                                   [--memory]
                                   [--mi-system-assigned]
                                   [--mi-user-assigned]
                                   [--network-status {EgressDisabled, EgressEnabled}]
                                   [--no-wait]
                                   [--ready-sessions]
                                   [--registry-identity]
                                   [--registry-password]
                                   [--registry-server]
                                   [--registry-username]
                                   [--secrets]
                                   [--target-port]

例

コンテナーの種類が PythonLTS の既定の設定でセッション プールを作成または更新します。

az containerapp sessionpool create -n mysessionpool -g MyResourceGroup \
    --location eastasia

コンテナーの種類が PythonLTS のセッション プールを作成または更新します。同時セッションの最大数は 30、準備完了セッション インスタンス 20 です。

az containerapp sessionpool create -n mysessionpool -g MyResourceGroup \
    --container-type PythonLTS --max-sessions 30 --ready-sessions 20 \
    --location eastasia

既定のクイック スタート イメージを使用して、コンテナーの種類が CustomContainer のセッション プールを作成または更新します。

az containerapp sessionpool create -n mysessionpool -g MyResourceGroup \
    --container-type CustomContainer --environment MyEnvironment \
    --cpu 0.5 --memory 1Gi --target-port 80 --location eastasia --image mcr.microsoft.com/k8se/quickstart:latest

シークレットと環境変数を持つコンテナーの種類 CustomContainer を使用してセッション プールを作成または更新します。

az containerapp sessionpool create -n mysessionpool -g MyResourceGroup \
    --container-type CustomContainer --environment MyEnvironment \
    --cpu 0.5 --memory 1Gi --target-port 80 --image MyImage \
    --env-vars GREETING="Hello, world" SECRETENV=secretref:anothersecret \
    --secrets mysecret=secretvalue1 anothersecret="secret value 2" --location eastasia

プライベート レジストリからのコンテナーの種類 CustomContainer を使用してセッション プールを作成または更新する

az containerapp sessionpool create -n mysessionpool -g MyResourceGroup \
    --container-type CustomContainer --environment MyEnvironment --image MyImage \
    --cpu 0.5 --memory 1Gi --target-port 80 --registry-server myregistry.azurecr.io \
    --registry-username myregistry --registry-password $REGISTRY_PASSWORD \
    --location eastasia

Azure コンテナー レジストリを認証するために、コンテナーの種類が CustomContainer とマネージド ID のセッション プールを作成または更新する

az containerapp sessionpool create -n mysessionpool -g MyResourceGroup \
    --container-type CustomContainer --environment MyEnvironment --image MyImage \
    --cpu 0.5 --memory 1Gi --target-port 80 --registry-server myregistry.azurecr.io \
    --registry-identity  MyUserIdentityResourceId \
    --location eastasia

システム割り当て ID とユーザー割り当て ID を使用して、コンテナーの種類が CustomContainer のセッション プールを作成または更新します。

az containerapp sessionpool create -n mysessionpool -g MyResourceGroup \
    --container-type CustomContainer --environment MyEnvironment --image MyImage \
    --cpu 0.5 --memory 1Gi --target-port 80 \
    --mi-system-assigned --mi-user-assigned MyUserIdentityResourceId \
    --location eastasia

クールダウン期間 360s のコンテナーの種類 CustomContainer を使用してセッション プールを作成または更新する

az containerapp sessionpool create -n mysessionpool -g MyResourceGroup \
    --environment MyEnvironment --cpu 0.5 --memory 1Gi --target-port 80 --container-type CustomContainer \
    --cooldown-period 360 --location eastasia

必須のパラメーター

--name -n

セッション プール名。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--args

コンテナーのスタートアップ コマンド引数の一覧。 スペース区切りの値 (例: "-c" "mycommand")。 既存の値をクリアする空の文字列。

--command

起動時に実行されるコンテナーでサポートされているコマンドの一覧。 スペース区切りの値 (例: "/bin/queue" "mycommand")。 既存の値をクリアする空の文字列。

--container-name

コンテナーの名前。 作成時にコンテナー名が指定されていない場合、コンテナー名は既定で小文字に対応するセッション プールの名前になります。

--container-type

セッション プールのプールの種類(default='PythonLTS')。

指定可能な値: CustomContainer, NodeLTS, PythonLTS

--cooldown-period

セッションが削除される期間 (秒単位)、既定値は 300 です。

--cpu

0.25 から 2.0 のコアで必要な CPU (例: 0.5)。

--env-vars

コンテナーの環境変数の一覧。 'key=value' 形式のスペース区切り値。 既存の値をクリアする空の文字列。 シークレットを参照するためのプレフィックス値に 'secretref:' を付けます。

--environment

コンテナー アプリの環境の名前またはリソース ID。

--image -i

コンテナー イメージ (publisher/image-name:tag など)。

--location -l

Location。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--max-sessions

セッションの最大数は同時に実行できます。

--memory

"Gi" で終わる 0.5 ~ 4.0 の必要なメモリ (例: 1.0Gi)。

--mi-system-assigned

システム割り当て ID を割り当てるかどうかを示すブール値。

規定値: False

--mi-user-assigned

割り当てるスペース区切りのユーザー ID。

--network-status

エグレスがセッションに対して有効かどうか。

指定可能な値: EgressDisabled, EgressEnabled

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--ready-sessions

セッション プールで常に準備が整うセッションの数。

--registry-identity

Azure Container Registry に対する認証に使用するマネージド ID (ユーザー名/パスワードではなく)。 システム割り当て ID には 'system' を使用し、ユーザー割り当て ID にはリソース ID を使用します。 マネージド ID には、デプロイ前に ACR に対する acrpull アクセス許可が割り当てられている必要があります ('az role assignment create --role acrpull ...' を使用します)。

--registry-password

コンテナー レジストリにログインするためのパスワード。 シークレットとして格納される場合、値は 'secretref:' の後にシークレット名が続く必要があります。

--registry-server

コンテナー レジストリ サーバーのホスト名 (例: myregistry.azurecr.io)。

--registry-username

コンテナー レジストリにログインするユーザー名。

--secrets -s

セッション プールのシークレットの一覧。 'key=value' 形式のスペース区切り値。 既存の値をクリアする空の文字列。

--target-port

イングレス トラフィック用に使うセッション ポート。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az containerapp sessionpool delete

セッション プールを削除します。

az containerapp sessionpool delete --resource-group
                                   [--ids]
                                   [--name]
                                   [--no-wait]
                                   [--subscription]
                                   [--yes]

例

セッション プールを削除します。

az containerapp sessionpool delete -n mysessionpool -g MyResourceGroup

必須のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

セッション プール名。

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--yes -y

確認のダイアログを表示しません。

規定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az containerapp sessionpool list

サブスクリプションまたはリソース グループ別にセッション プールを一覧表示します。

az containerapp sessionpool list [--resource-group]

例

現在のサブスクリプションのセッション プールを一覧表示します。

az containerapp sessionpool list

リソース グループ別にセッション プールを一覧表示します。

az containerapp sessionpool list -g MyResourceGroup

省略可能のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az containerapp sessionpool show

セッション プールの詳細を表示します。

az containerapp sessionpool show --resource-group
                                 [--ids]
                                 [--name]
                                 [--subscription]

例

セッション プールの詳細を表示します。

az containerapp sessionpool show -n mysessionpool -g MyResourceGroup

必須のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

セッション プール名。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az containerapp sessionpool update

セッション プールを更新します。

az containerapp sessionpool update --resource-group
                                   [--args]
                                   [--command]
                                   [--container-name]
                                   [--cooldown-period]
                                   [--cpu]
                                   [--env-vars]
                                   [--ids]
                                   [--image]
                                   [--location]
                                   [--max-sessions]
                                   [--memory]
                                   [--name]
                                   [--network-status {EgressDisabled, EgressEnabled}]
                                   [--no-wait]
                                   [--ready-sessions]
                                   [--registry-password]
                                   [--registry-server]
                                   [--registry-username]
                                   [--secrets]
                                   [--subscription]
                                   [--target-port]

例

セッション プールの最大同時セッション構成とイメージを更新します。

az containerapp sessionpool update -n mysessionpool -g MyResourceGroup --max-sessions 20 --image MyNewImage

必須のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--args

コンテナーのスタートアップ コマンド引数の一覧。 スペース区切りの値 (例: "-c" "mycommand")。 既存の値をクリアする空の文字列。

--command

起動時に実行されるコンテナーでサポートされているコマンドの一覧。 スペース区切りの値 (例: "/bin/queue" "mycommand")。 既存の値をクリアする空の文字列。

--container-name

コンテナーの名前。 作成時にコンテナー名が指定されていない場合、コンテナー名は既定で小文字に対応するセッション プールの名前になります。

--cooldown-period

セッションが削除される期間 (秒単位)、既定値は 300 です。

--cpu

0.25 から 2.0 のコアで必要な CPU (例: 0.5)。

--env-vars

コンテナーの環境変数の一覧。 'key=value' 形式のスペース区切り値。 既存の値をクリアする空の文字列。 シークレットを参照するためのプレフィックス値に 'secretref:' を付けます。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--image -i

コンテナー イメージ (publisher/image-name:tag など)。

--location -l

Location。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--max-sessions

セッションの最大数は同時に実行できます。

--memory

"Gi" で終わる 0.5 ~ 4.0 の必要なメモリ (例: 1.0Gi)。

--name -n

セッション プール名。

--network-status

エグレスがセッションに対して有効かどうか。

指定可能な値: EgressDisabled, EgressEnabled

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--ready-sessions

セッション プールで常に準備が整うセッションの数。

--registry-password

コンテナー レジストリにログインするためのパスワード。 シークレットとして格納される場合、値は 'secretref:' の後にシークレット名が続く必要があります。

--registry-server

コンテナー レジストリ サーバーのホスト名 (例: myregistry.azurecr.io)。

--registry-username

コンテナー レジストリにログインするユーザー名。

--secrets -s

セッション プールのシークレットの一覧。 'key=value' 形式のスペース区切り値。 既存の値をクリアする空の文字列。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--target-port

イングレス トラフィック用に使うセッション ポート。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。