Container Apps Session Pools - Get
Obtenha as propriedades de um pool de sessões.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/sessionPools/{sessionPoolName}?api-version=2025-01-01
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string minLength: 1maxLength: 90 |
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas. |
session
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[a-z][a-z0-9]*$ |
Nome do pool de sessões. |
subscription
|
path | True |
string (uuid) |
A ID da assinatura de destino. O valor deve ser uma UUID. |
api-version
|
query | True |
string minLength: 1 |
A versão da API a ser usada para esta operação. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
OKEY. |
|
Other Status Codes |
Resposta de erro comum. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
Nome | Description |
---|---|
user_impersonation | representar sua conta de usuário |
Exemplos
Get Session Pool
Solicitação de exemplo
Resposta de exemplo
{
"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"
}
}
Definições
Nome | Description |
---|---|
Container |
O tipo de contêiner das sessões. |
created |
O tipo de identidade que criou o recurso. |
Custom |
Configuração de contêiner personalizado. |
Dynamic |
Configuração do pool dinâmico. |
Environment |
Variável de ambiente de contêiner do Aplicativo de Contêiner. |
Error |
As informações adicionais do erro de gerenciamento de recursos. |
Error |
O detalhe do erro. |
Error |
Resposta de erro |
Identity |
Use para selecionar os estágios do ciclo de vida de um Pool de Sessão durante o qual a Identidade Gerenciada deve estar disponível. |
Lifecycle |
As propriedades de configuração do ciclo de vida de uma sessão no pool de sessão dinâmica |
Lifecycle |
O tipo de ciclo de vida do pool de sessão. |
Managed |
Configurações opcionais para uma Identidade Gerenciada atribuída ao pool de sessão. |
Managed |
Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário) |
Managed |
Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos). |
Pool |
O tipo de gerenciamento de pool do pool de sessões. |
Scale |
Configuração de escala. |
Session |
Definições de contêiner para as sessões do pool de sessão. |
Session |
Requisitos de recurso de contêiner para sessões do pool de sessão. |
Session |
Configuração de entrada do pool de sessão. |
Session |
Configuração de rede de sessão. |
Session |
Status da rede para as sessões. |
Session |
Pool de sessões do Aplicativo de Contêiner. |
Session |
Estado de provisionamento do pool de sessões. |
Session |
Definição secreta. |
Session |
Credenciais do registro privado do pool de sessões. |
system |
Metadados relativos à criação e última modificação do recurso. |
User |
Propriedades de identidade atribuídas pelo usuário |
ContainerType
O tipo de contêiner das sessões.
Valor | Description |
---|---|
CustomContainer | |
PythonLTS |
createdByType
O tipo de identidade que criou o recurso.
Valor | Description |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
CustomContainerTemplate
Configuração de contêiner personalizado.
Nome | Tipo | Description |
---|---|---|
containers |
Lista de definições de contêiner para as sessões do pool de sessão. |
|
ingress |
Configuração de entrada do pool de sessão. |
|
registryCredentials |
Credenciais de registro de contêiner privado para contêineres usados pelas sessões do pool de sessão. |
DynamicPoolConfiguration
Configuração do pool dinâmico.
Nome | Tipo | Description |
---|---|---|
lifecycleConfiguration |
A configuração do ciclo de vida de uma sessão no pool de sessão dinâmica |
EnvironmentVar
Variável de ambiente de contêiner do Aplicativo de Contêiner.
Nome | Tipo | Description |
---|---|---|
name |
string |
Nome da variável de ambiente. |
secretRef |
string |
Nome do segredo do Aplicativo de Contêiner do qual extrair o valor da variável de ambiente. |
value |
string |
Valor de variável de ambiente não secreto. |
ErrorAdditionalInfo
As informações adicionais do erro de gerenciamento de recursos.
Nome | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
Nome | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
Nome | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
IdentitySettingsLifeCycle
Use para selecionar os estágios do ciclo de vida de um Pool de Sessão durante o qual a Identidade Gerenciada deve estar disponível.
Valor | Description |
---|---|
Main | |
None |
LifecycleConfiguration
As propriedades de configuração do ciclo de vida de uma sessão no pool de sessão dinâmica
Nome | Tipo | Description |
---|---|---|
cooldownPeriodInSeconds |
integer (int32) |
O período de resfriamento de uma sessão em segundos, quando o tipo de ciclo de vida é "Cronometrado". |
lifecycleType |
O tipo de ciclo de vida do pool de sessão. |
|
maxAlivePeriodInSeconds |
integer (int32) |
O período máximo ativo de uma sessão em segundos quando o tipo de ciclo de vida é 'OnContainerExit'. |
LifecycleType
O tipo de ciclo de vida do pool de sessão.
Valor | Description |
---|---|
OnContainerExit | |
Timed |
ManagedIdentitySetting
Configurações opcionais para uma Identidade Gerenciada atribuída ao pool de sessão.
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
identity |
string |
A ID de recurso de uma identidade gerenciada atribuída pelo usuário atribuída ao Pool de Sessão ou "sistema" para a identidade atribuída pelo sistema. |
|
lifecycle | None |
Use para selecionar os estágios do ciclo de vida de um Pool de Sessão durante o qual a Identidade Gerenciada deve estar disponível. |
ManagedServiceIdentity
Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário)
Nome | Tipo | Description |
---|---|---|
principalId |
string (uuid) |
A ID da entidade de serviço da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema. |
tenantId |
string (uuid) |
A ID do locatário da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema. |
type |
Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos). |
|
userAssignedIdentities |
<string,
User |
Identidades de User-Assigned |
ManagedServiceIdentityType
Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).
Valor | Description |
---|---|
None | |
SystemAssigned | |
SystemAssigned,UserAssigned | |
UserAssigned |
PoolManagementType
O tipo de gerenciamento de pool do pool de sessões.
Valor | Description |
---|---|
Dynamic | |
Manual |
ScaleConfiguration
Configuração de escala.
Nome | Tipo | Description |
---|---|---|
maxConcurrentSessions |
integer (int32) |
A contagem máxima de sessões ao mesmo tempo. |
readySessionInstances |
integer (int32) |
A contagem mínima de instâncias de sessão prontas. |
SessionContainer
Definições de contêiner para as sessões do pool de sessão.
Nome | Tipo | Description |
---|---|---|
args |
string[] |
Argumentos de comando de início de contêiner. |
command |
string[] |
Comando de início do contêiner. |
env |
Variáveis de ambiente de contêiner. |
|
image |
string |
Marca de imagem de contêiner. |
name |
string |
Nome do contêiner personalizado. |
resources |
Requisitos de recursos de contêiner. |
SessionContainerResources
Requisitos de recurso de contêiner para sessões do pool de sessão.
Nome | Tipo | Description |
---|---|---|
cpu |
number (double) |
CPU necessária em núcleos, por exemplo, 0,5 |
memory |
string |
Memória necessária, por exemplo, "250 Mb" |
SessionIngress
Configuração de entrada do pool de sessão.
Nome | Tipo | Description |
---|---|---|
targetPort |
integer (int32) |
Porta de destino em contêineres para tráfego de entrada |
SessionNetworkConfiguration
Configuração de rede de sessão.
Nome | Tipo | Description |
---|---|---|
status |
Status da rede para as sessões. |
SessionNetworkStatus
Status da rede para as sessões.
Valor | Description |
---|---|
EgressDisabled | |
EgressEnabled |
SessionPool
Pool de sessões do Aplicativo de Contêiner.
Nome | Tipo | Description |
---|---|---|
id |
string (arm-id) |
ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
identity |
Identidades gerenciadas necessárias por um pool de sessões para interagir com outros serviços do Azure para não manter segredos ou credenciais no código. |
|
location |
string |
A localização geográfica onde o recurso reside |
name |
string |
O nome do recurso |
properties.containerType |
O tipo de contêiner das sessões. |
|
properties.customContainerTemplate |
A configuração de contêiner personalizado se o containerType for CustomContainer. |
|
properties.dynamicPoolConfiguration |
A configuração do pool se o poolManagementType for dinâmico. |
|
properties.environmentId |
string (arm-id) |
ID do recurso do ambiente do pool de sessão. |
properties.managedIdentitySettings |
Configurações opcionais para uma Identidade Gerenciada atribuída ao pool de sessão. |
|
properties.nodeCount |
integer (int32) |
O número de nós que o pool de sessão está usando. |
properties.poolManagementEndpoint |
string (uri) |
O ponto de extremidade para gerenciar o pool. |
properties.poolManagementType |
O tipo de gerenciamento de pool do pool de sessões. |
|
properties.provisioningState |
Estado de provisionamento do pool de sessões. |
|
properties.scaleConfiguration |
A configuração de escala do pool de sessões. |
|
properties.secrets |
Os segredos do pool de sessões. |
|
properties.sessionNetworkConfiguration |
A configuração de rede das sessões no pool de sessões. |
|
systemData |
Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy. |
|
tags |
object |
Marcas de recurso. |
type |
string |
O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
SessionPoolProvisioningState
Estado de provisionamento do pool de sessões.
Valor | Description |
---|---|
Canceled | |
Deleting | |
Failed | |
InProgress | |
Succeeded |
SessionPoolSecret
Definição secreta.
Nome | Tipo | Description |
---|---|---|
name |
string |
Nome do segredo. |
value |
string |
Valor secreto. |
SessionRegistryCredentials
Credenciais do registro privado do pool de sessões.
Nome | Tipo | Description |
---|---|---|
identity |
string |
Uma Identidade Gerenciada a ser usada para autenticar com o Registro de Contêiner do Azure. Para identidades atribuídas pelo usuário, use a ID completa do recurso de identidade atribuída pelo usuário. Para identidades atribuídas pelo sistema, use 'system' |
passwordSecretRef |
string |
O nome do segredo que contém a senha de logon do Registro |
server |
string |
Servidor do Registro de Contêiner. |
username |
string |
Nome de usuário do Registro de Contêiner. |
systemData
Metadados relativos à criação e última modificação do recurso.
Nome | Tipo | Description |
---|---|---|
createdAt |
string (date-time) |
O carimbo de data/hora da criação de recursos (UTC). |
createdBy |
string |
A identidade que criou o recurso. |
createdByType |
O tipo de identidade que criou o recurso. |
|
lastModifiedAt |
string (date-time) |
O carimbo de data/hora da última modificação do recurso (UTC) |
lastModifiedBy |
string |
A identidade que modificou o recurso pela última vez. |
lastModifiedByType |
O tipo de identidade que modificou o recurso pela última vez. |
UserAssignedIdentity
Propriedades de identidade atribuídas pelo usuário
Nome | Tipo | Description |
---|---|---|
clientId |
string (uuid) |
A ID do cliente da identidade atribuída. |
principalId |
string (uuid) |
A ID da entidade de segurança da identidade atribuída. |