Microsoft.App/sessionPools 2024-02-02-preview - Bicep, ARM template & Terraform AzAPI reference

Definição de recurso do Bicep

O tipo de recurso sessionPools pode ser implantado com operações direcionadas:

Grupos de recursos - Consulte comandos de implantação do grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso de Microsoft.App/sessionPools, adicione o seguinte Bicep ao modelo.

resource symbolicname 'Microsoft.App/sessionPools@2024-02-02-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    containerType: 'string'
    customContainerTemplate: {
      containers: [
        {
          args: [
            'string'
          ]
          command: [
            'string'
          ]
          env: [
            {
              name: 'string'
              secretRef: 'string'
              value: 'string'
            }
          ]
          image: 'string'
          name: 'string'
          resources: {
            cpu: int
            memory: 'string'
          }
        }
      ]
      ingress: {
        targetPort: int
      }
      registryCredentials: {
        passwordSecretRef: 'string'
        registryServer: 'string'
        username: 'string'
      }
    }
    dynamicPoolConfiguration: {
      cooldownPeriodInSeconds: int
      executionType: 'string'
    }
    environmentId: 'string'
    poolManagementType: 'string'
    scaleConfiguration: {
      maxConcurrentSessions: int
      readySessionInstances: int
    }
    secrets: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    sessionNetworkConfiguration: {
      status: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

CustomContainerTemplate

Nome	Descrição	Valor
Recipientes	Lista de definições de contêiner para as sessões do pool de sessão.	SessionContainer[]
Entrada	Configuração de entrada do pool de sessão.	SessionIngress
RegistryCredentials	Credenciais de registro de contêiner privado para contêineres usados pelas sessões do pool de sessão.	SessionRegistryCredentials

DynamicPoolConfiguration

Nome	Descrição	Valor
cooldownPeriodInSeconds	O período de resfriamento de uma sessão em segundos.	int
executionType	O tipo de execução do pool de sessão.	'Timed'

EnvironmentVar

Nome	Descrição	Valor
nome	Nome da variável de ambiente.	corda
secretRef	Nome do segredo do Aplicativo de Contêiner do qual extrair o valor da variável de ambiente.	corda
valor	Valor de variável de ambiente não secreto.	corda

Microsoft.App/sessionPools

Nome	Descrição	Valor
localização	A localização geográfica onde o recurso reside	cadeia de caracteres (obrigatório)
nome	O nome do recurso	corda Restrições: Comprimento mínimo = 3 Comprimento máximo = 63 Padrão = `^[a-z][a-z0-9]*$` (obrigatório)
Propriedades	Propriedades específicas do recurso do pool de sessões do Aplicativo de Contêiner	SessionPoolProperties
Tags	Marcas de recurso	Dicionário de nomes e valores de marca. Consulte Marcas em modelos

ScaleConfiguration

Nome	Descrição	Valor
maxConcurrentSessions	A contagem máxima de sessões ao mesmo tempo.	int
readySessionInstances	A contagem mínima de instâncias de sessão prontas.	int

SessionContainer

Nome	Descrição	Valor
args	Argumentos de comando de início de contêiner.	string[]
comando	Comando de início do contêiner.	string[]
Env	Variáveis de ambiente de contêiner.	EnvironmentVar []
imagem	Marca de imagem de contêiner.	corda
nome	Nome do contêiner personalizado.	corda
Recursos	Requisitos de recursos de contêiner.	SessionContainerResources

SessionContainerResources

Nome	Descrição	Valor
CPU	CPU necessária em núcleos, por exemplo, 0,5	int
memória	Memória necessária, por exemplo, "250 Mb"	corda

SessionIngress

Nome	Descrição	Valor
targetPort	Porta de destino em contêineres para tráfego de entrada	int

SessionNetworkConfiguration

Nome	Descrição	Valor
estado	Status da rede para as sessões.	'Saída Desabilitada' 'EgressEnabled'

SessionPoolProperties

Nome	Descrição	Valor
containerType	O tipo de contêiner das sessões.	'CustomContainer' 'PythonLTS'
customContainerTemplate	A configuração de contêiner personalizado se o containerType for CustomContainer.	CustomContainerTemplate
dynamicPoolConfiguration	A configuração do pool se o poolManagementType for dinâmico.	DynamicPoolConfiguration
environmentId	ID do recurso do ambiente do pool de sessão.	corda
poolManagementType	O tipo de gerenciamento de pool do pool de sessões.	'Dinâmico' 'Manual'
scaleConfiguration	A configuração de escala do pool de sessões.	ScaleConfiguration
Segredos	Os segredos do pool de sessões.	SessionPoolSecret []
sessionNetworkConfiguration	A configuração de rede das sessões no pool de sessões.	SessionNetworkConfiguration

SessionPoolSecret

Nome	Descrição	Valor
nome	Nome do segredo.	corda
valor	Valor secreto.	corda Restrições: Valor confidencial. Passe como um parâmetro seguro.

SessionRegistryCredentials

Nome	Descrição	Valor
passwordSecretRef	O nome do segredo que contém a senha de logon do Registro	corda
RegistryServer	Servidor do Registro de Contêiner.	corda
nome de usuário	Nome de usuário do Registro de Contêiner.	corda

TrackedResourceTags

Nome	Descrição	Valor

Exemplos de uso

Módulos verificados do Azure

O módulos verificados do Azure a seguir pode ser usado para implantar esse tipo de recurso.

Módulo	Descrição
do Pool de Sessões de Aplicativo	Módulo de recurso AVM para pool de sessão de aplicativo

Definição de recurso de modelo do ARM

O tipo de recurso sessionPools pode ser implantado com operações direcionadas:

Grupos de recursos - Consulte comandos de implantação do grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso de Microsoft.App/sessionPools, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.App/sessionPools",
  "apiVersion": "2024-02-02-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "containerType": "string",
    "customContainerTemplate": {
      "containers": [
        {
          "args": [ "string" ],
          "command": [ "string" ],
          "env": [
            {
              "name": "string",
              "secretRef": "string",
              "value": "string"
            }
          ],
          "image": "string",
          "name": "string",
          "resources": {
            "cpu": "int",
            "memory": "string"
          }
        }
      ],
      "ingress": {
        "targetPort": "int"
      },
      "registryCredentials": {
        "passwordSecretRef": "string",
        "registryServer": "string",
        "username": "string"
      }
    },
    "dynamicPoolConfiguration": {
      "cooldownPeriodInSeconds": "int",
      "executionType": "string"
    },
    "environmentId": "string",
    "poolManagementType": "string",
    "scaleConfiguration": {
      "maxConcurrentSessions": "int",
      "readySessionInstances": "int"
    },
    "secrets": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "sessionNetworkConfiguration": {
      "status": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

CustomContainerTemplate

Nome	Descrição	Valor
Recipientes	Lista de definições de contêiner para as sessões do pool de sessão.	SessionContainer[]
Entrada	Configuração de entrada do pool de sessão.	SessionIngress
RegistryCredentials	Credenciais de registro de contêiner privado para contêineres usados pelas sessões do pool de sessão.	SessionRegistryCredentials

DynamicPoolConfiguration

Nome	Descrição	Valor
cooldownPeriodInSeconds	O período de resfriamento de uma sessão em segundos.	int
executionType	O tipo de execução do pool de sessão.	'Timed'

EnvironmentVar

Nome	Descrição	Valor
nome	Nome da variável de ambiente.	corda
secretRef	Nome do segredo do Aplicativo de Contêiner do qual extrair o valor da variável de ambiente.	corda
valor	Valor de variável de ambiente não secreto.	corda

Microsoft.App/sessionPools

Nome	Descrição	Valor
apiVersion	A versão da API	'2024-02-02-preview'
localização	A localização geográfica onde o recurso reside	cadeia de caracteres (obrigatório)
nome	O nome do recurso	corda Restrições: Comprimento mínimo = 3 Comprimento máximo = 63 Padrão = `^[a-z][a-z0-9]*$` (obrigatório)
Propriedades	Propriedades específicas do recurso do pool de sessões do Aplicativo de Contêiner	SessionPoolProperties
Tags	Marcas de recurso	Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo	O tipo de recurso	'Microsoft.App/sessionPools'

ScaleConfiguration

Nome	Descrição	Valor
maxConcurrentSessions	A contagem máxima de sessões ao mesmo tempo.	int
readySessionInstances	A contagem mínima de instâncias de sessão prontas.	int

SessionContainer

Nome	Descrição	Valor
args	Argumentos de comando de início de contêiner.	string[]
comando	Comando de início do contêiner.	string[]
Env	Variáveis de ambiente de contêiner.	EnvironmentVar []
imagem	Marca de imagem de contêiner.	corda
nome	Nome do contêiner personalizado.	corda
Recursos	Requisitos de recursos de contêiner.	SessionContainerResources

SessionContainerResources

Nome	Descrição	Valor
CPU	CPU necessária em núcleos, por exemplo, 0,5	int
memória	Memória necessária, por exemplo, "250 Mb"	corda

SessionIngress

Nome	Descrição	Valor
targetPort	Porta de destino em contêineres para tráfego de entrada	int

SessionNetworkConfiguration

Nome	Descrição	Valor
estado	Status da rede para as sessões.	'Saída Desabilitada' 'EgressEnabled'

SessionPoolProperties

Nome	Descrição	Valor
containerType	O tipo de contêiner das sessões.	'CustomContainer' 'PythonLTS'
customContainerTemplate	A configuração de contêiner personalizado se o containerType for CustomContainer.	CustomContainerTemplate
dynamicPoolConfiguration	A configuração do pool se o poolManagementType for dinâmico.	DynamicPoolConfiguration
environmentId	ID do recurso do ambiente do pool de sessão.	corda
poolManagementType	O tipo de gerenciamento de pool do pool de sessões.	'Dinâmico' 'Manual'
scaleConfiguration	A configuração de escala do pool de sessões.	ScaleConfiguration
Segredos	Os segredos do pool de sessões.	SessionPoolSecret []
sessionNetworkConfiguration	A configuração de rede das sessões no pool de sessões.	SessionNetworkConfiguration

SessionPoolSecret

Nome	Descrição	Valor
nome	Nome do segredo.	corda
valor	Valor secreto.	corda Restrições: Valor confidencial. Passe como um parâmetro seguro.

SessionRegistryCredentials

Nome	Descrição	Valor
passwordSecretRef	O nome do segredo que contém a senha de logon do Registro	corda
RegistryServer	Servidor do Registro de Contêiner.	corda
nome de usuário	Nome de usuário do Registro de Contêiner.	corda

TrackedResourceTags

Nome	Descrição	Valor

Exemplos de uso

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso sessionPools pode ser implantado com operações direcionadas:

grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso de Microsoft.App/sessionPools, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.App/sessionPools@2024-02-02-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      containerType = "string"
      customContainerTemplate = {
        containers = [
          {
            args = [
              "string"
            ]
            command = [
              "string"
            ]
            env = [
              {
                name = "string"
                secretRef = "string"
                value = "string"
              }
            ]
            image = "string"
            name = "string"
            resources = {
              cpu = int
              memory = "string"
            }
          }
        ]
        ingress = {
          targetPort = int
        }
        registryCredentials = {
          passwordSecretRef = "string"
          registryServer = "string"
          username = "string"
        }
      }
      dynamicPoolConfiguration = {
        cooldownPeriodInSeconds = int
        executionType = "string"
      }
      environmentId = "string"
      poolManagementType = "string"
      scaleConfiguration = {
        maxConcurrentSessions = int
        readySessionInstances = int
      }
      secrets = [
        {
          name = "string"
          value = "string"
        }
      ]
      sessionNetworkConfiguration = {
        status = "string"
      }
    }
  })
}

Valores de propriedade

CustomContainerTemplate

Nome	Descrição	Valor
Recipientes	Lista de definições de contêiner para as sessões do pool de sessão.	SessionContainer[]
Entrada	Configuração de entrada do pool de sessão.	SessionIngress
RegistryCredentials	Credenciais de registro de contêiner privado para contêineres usados pelas sessões do pool de sessão.	SessionRegistryCredentials

DynamicPoolConfiguration

Nome	Descrição	Valor
cooldownPeriodInSeconds	O período de resfriamento de uma sessão em segundos.	int
executionType	O tipo de execução do pool de sessão.	'Timed'

EnvironmentVar

Nome	Descrição	Valor
nome	Nome da variável de ambiente.	corda
secretRef	Nome do segredo do Aplicativo de Contêiner do qual extrair o valor da variável de ambiente.	corda
valor	Valor de variável de ambiente não secreto.	corda

Microsoft.App/sessionPools

Nome	Descrição	Valor
localização	A localização geográfica onde o recurso reside	cadeia de caracteres (obrigatório)
nome	O nome do recurso	corda Restrições: Comprimento mínimo = 3 Comprimento máximo = 63 Padrão = `^[a-z][a-z0-9]*$` (obrigatório)
Propriedades	Propriedades específicas do recurso do pool de sessões do Aplicativo de Contêiner	SessionPoolProperties
Tags	Marcas de recurso	Dicionário de nomes e valores de marca.
tipo	O tipo de recurso	"Microsoft.App/sessionPools@2024-02-02-preview"

ScaleConfiguration

Nome	Descrição	Valor
maxConcurrentSessions	A contagem máxima de sessões ao mesmo tempo.	int
readySessionInstances	A contagem mínima de instâncias de sessão prontas.	int

SessionContainer

Nome	Descrição	Valor
args	Argumentos de comando de início de contêiner.	string[]
comando	Comando de início do contêiner.	string[]
Env	Variáveis de ambiente de contêiner.	EnvironmentVar []
imagem	Marca de imagem de contêiner.	corda
nome	Nome do contêiner personalizado.	corda
Recursos	Requisitos de recursos de contêiner.	SessionContainerResources

SessionContainerResources

Nome	Descrição	Valor
CPU	CPU necessária em núcleos, por exemplo, 0,5	int
memória	Memória necessária, por exemplo, "250 Mb"	corda

SessionIngress

Nome	Descrição	Valor
targetPort	Porta de destino em contêineres para tráfego de entrada	int

SessionNetworkConfiguration

Nome	Descrição	Valor
estado	Status da rede para as sessões.	'Saída Desabilitada' 'EgressEnabled'

SessionPoolProperties

Nome	Descrição	Valor
containerType	O tipo de contêiner das sessões.	'CustomContainer' 'PythonLTS'
customContainerTemplate	A configuração de contêiner personalizado se o containerType for CustomContainer.	CustomContainerTemplate
dynamicPoolConfiguration	A configuração do pool se o poolManagementType for dinâmico.	DynamicPoolConfiguration
environmentId	ID do recurso do ambiente do pool de sessão.	corda
poolManagementType	O tipo de gerenciamento de pool do pool de sessões.	'Dinâmico' 'Manual'
scaleConfiguration	A configuração de escala do pool de sessões.	ScaleConfiguration
Segredos	Os segredos do pool de sessões.	SessionPoolSecret []
sessionNetworkConfiguration	A configuração de rede das sessões no pool de sessões.	SessionNetworkConfiguration

SessionPoolSecret

Nome	Descrição	Valor
nome	Nome do segredo.	corda
valor	Valor secreto.	corda Restrições: Valor confidencial. Passe como um parâmetro seguro.

SessionRegistryCredentials

Nome	Descrição	Valor
passwordSecretRef	O nome do segredo que contém a senha de logon do Registro	corda
RegistryServer	Servidor do Registro de Contêiner.	corda
nome de usuário	Nome de usuário do Registro de Contêiner.	corda

TrackedResourceTags

Nome	Descrição	Valor

Compartilhar via

Microsoft.App sessionPools 2024-02-02-preview

Definição de recurso do Bicep

Formato de recurso

Valores de propriedade

CustomContainerTemplate

DynamicPoolConfiguration

EnvironmentVar

Microsoft.App/sessionPools

ScaleConfiguration

SessionContainer

SessionContainerResources

SessionIngress

SessionNetworkConfiguration

SessionPoolProperties

SessionPoolSecret

SessionRegistryCredentials

TrackedResourceTags

Exemplos de uso

Módulos verificados do Azure

Definição de recurso de modelo do ARM

Formato de recurso

Valores de propriedade

CustomContainerTemplate

DynamicPoolConfiguration

EnvironmentVar

Microsoft.App/sessionPools

ScaleConfiguration

SessionContainer

SessionContainerResources

SessionIngress

SessionNetworkConfiguration

SessionPoolProperties

SessionPoolSecret

SessionRegistryCredentials

TrackedResourceTags

Exemplos de uso

Definição de recurso do Terraform (provedor de AzAPI)

Formato de recurso

Valores de propriedade

CustomContainerTemplate

DynamicPoolConfiguration

EnvironmentVar

Microsoft.App/sessionPools

ScaleConfiguration

SessionContainer

SessionContainerResources

SessionIngress

SessionNetworkConfiguration

SessionPoolProperties

SessionPoolSecret

SessionRegistryCredentials

TrackedResourceTags

Comentários

Recursos adicionais