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

Definição de recursos do bíceps

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

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

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

Formato do recurso

Para criar um recurso Microsoft.App/sessionPools, adicione o seguinte Bíceps ao seu modelo.

resource symbolicname 'Microsoft.App/sessionPools@2024-08-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: {
        identity: 'string'
        passwordSecretRef: 'string'
        server: '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

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

DynamicPoolConfiguration

Designação	Descrição	Valor
cooldownPeriodInSeconds	O período de reflexão de uma sessão em segundos.	Int
executionType	O tipo de execução do pool de sessões.	'Cronometrado'

AmbienteVar

Designação	Descrição	Valor
Designação	Nome da variável de ambiente.	string
secretRef	Nome do segredo do aplicativo de contêiner do qual extrair o valor da variável de ambiente.	string
valor	Valor da variável de ambiente não secreto.	string

Microsoft.App/sessionPools

Designação	Descrição	Valor
Localização	A geolocalização onde o recurso vive	string (obrigatório)
Designação	O nome do recurso	string Restrições: Comprimento mínimo = 3 Comprimento máximo = 3 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
Etiquetas	Tags de recursos	Dicionário de nomes e valores de tags. Consulte Tags em modelos

ScaleConfiguration

Designação	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

Designação	Descrição	Valor
Args	Argumentos do comando Container start.	string[]
comando	Comando Container start.	string[]
env	Variáveis de ambiente de contêiner.	EnvironmentVar[]
imagem	Tag de imagem de contêiner.	string
Designação	Nome do contêiner personalizado.	string
Recursos	Requisitos de recursos de contêiner.	SessionContainerResources

SessionContainerResources

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

SessionIngress

Designação	Descrição	Valor
Porto-alvo	Porta de destino em contentores para o tráfego de entrada	Int

SessionNetworkConfiguration

Designação	Descrição	Valor
Situação	Estado da rede para as sessões.	'EgressoDesativado' 'EgressEnabled'

SessionPoolProperties

Designação	Descrição	Valor
Tipo de contentor	O tipo de contêiner das sessões.	'CustomContainer' 'PythonLTS'
customContainerTemplate	A configuração de contêiner personalizada se 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ões.	string
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

Designação	Descrição	Valor
Designação	Nome secreto.	string
valor	Valor Secreto.	string Restrições: Valor sensível. Passe como um parâmetro seguro.

SessionRegistryCredentials

Designação	Descrição	Valor
identidade	Uma Identidade Gerenciada a ser usada para autenticar com o Registro de Contêiner do Azure. Para identidades atribuídas pelo usuário, use o ID de recurso de identidade atribuído pelo usuário completo. Para identidades atribuídas ao sistema, use 'system'	string
senhaSecretRef	O nome do segredo que contém a senha de login do Registro	string
servidor	Servidor de registro de contêiner.	string
nome de utilizador	Nome de usuário do registro de contêiner.	string

TrackedResourceTags

Designação	Descrição	Valor

Definição de recurso de modelo ARM

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

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

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

Formato do recurso

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

{
  "type": "Microsoft.App/sessionPools",
  "apiVersion": "2024-08-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": {
        "identity": "string",
        "passwordSecretRef": "string",
        "server": "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

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

DynamicPoolConfiguration

Designação	Descrição	Valor
cooldownPeriodInSeconds	O período de reflexão de uma sessão em segundos.	Int
executionType	O tipo de execução do pool de sessões.	'Cronometrado'

AmbienteVar

Designação	Descrição	Valor
Designação	Nome da variável de ambiente.	string
secretRef	Nome do segredo do aplicativo de contêiner do qual extrair o valor da variável de ambiente.	string
valor	Valor da variável de ambiente não secreto.	string

Microsoft.App/sessionPools

Designação	Descrição	Valor
apiVersion	A versão api	'2024-08-02-pré-visualização'
Localização	A geolocalização onde o recurso vive	string (obrigatório)
Designação	O nome do recurso	string Restrições: Comprimento mínimo = 3 Comprimento máximo = 3 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
Etiquetas	Tags de recursos	Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo	O tipo de recurso	'Microsoft.App/sessionPools'

ScaleConfiguration

Designação	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

Designação	Descrição	Valor
Args	Argumentos do comando Container start.	string[]
comando	Comando Container start.	string[]
env	Variáveis de ambiente de contêiner.	EnvironmentVar[]
imagem	Tag de imagem de contêiner.	string
Designação	Nome do contêiner personalizado.	string
Recursos	Requisitos de recursos de contêiner.	SessionContainerResources

SessionContainerResources

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

SessionIngress

Designação	Descrição	Valor
Porto-alvo	Porta de destino em contentores para o tráfego de entrada	Int

SessionNetworkConfiguration

Designação	Descrição	Valor
Situação	Estado da rede para as sessões.	'EgressoDesativado' 'EgressEnabled'

SessionPoolProperties

Designação	Descrição	Valor
Tipo de contentor	O tipo de contêiner das sessões.	'CustomContainer' 'PythonLTS'
customContainerTemplate	A configuração de contêiner personalizada se 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ões.	string
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

Designação	Descrição	Valor
Designação	Nome secreto.	string
valor	Valor Secreto.	string Restrições: Valor sensível. Passe como um parâmetro seguro.

SessionRegistryCredentials

Designação	Descrição	Valor
identidade	Uma Identidade Gerenciada a ser usada para autenticar com o Registro de Contêiner do Azure. Para identidades atribuídas pelo usuário, use o ID de recurso de identidade atribuído pelo usuário completo. Para identidades atribuídas ao sistema, use 'system'	string
senhaSecretRef	O nome do segredo que contém a senha de login do Registro	string
servidor	Servidor de registro de contêiner.	string
nome de utilizador	Nome de usuário do registro de contêiner.	string

TrackedResourceTags

Designação	Descrição	Valor

Definição de recursos Terraform (provedor 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 log de alterações.

Formato do recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.App/sessionPools@2024-08-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 = {
          identity = "string"
          passwordSecretRef = "string"
          server = "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

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

DynamicPoolConfiguration

Designação	Descrição	Valor
cooldownPeriodInSeconds	O período de reflexão de uma sessão em segundos.	Int
executionType	O tipo de execução do pool de sessões.	'Cronometrado'

AmbienteVar

Designação	Descrição	Valor
Designação	Nome da variável de ambiente.	string
secretRef	Nome do segredo do aplicativo de contêiner do qual extrair o valor da variável de ambiente.	string
valor	Valor da variável de ambiente não secreto.	string

Microsoft.App/sessionPools

Designação	Descrição	Valor
Localização	A geolocalização onde o recurso vive	string (obrigatório)
Designação	O nome do recurso	string Restrições: Comprimento mínimo = 3 Comprimento máximo = 3 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
Etiquetas	Tags de recursos	Dicionário de nomes e valores de tags.
tipo	O tipo de recurso	"Microsoft.App/sessionPools@2024-08-02-preview"

ScaleConfiguration

Designação	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

Designação	Descrição	Valor
Args	Argumentos do comando Container start.	string[]
comando	Comando Container start.	string[]
env	Variáveis de ambiente de contêiner.	EnvironmentVar[]
imagem	Tag de imagem de contêiner.	string
Designação	Nome do contêiner personalizado.	string
Recursos	Requisitos de recursos de contêiner.	SessionContainerResources

SessionContainerResources

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

SessionIngress

Designação	Descrição	Valor
Porto-alvo	Porta de destino em contentores para o tráfego de entrada	Int

SessionNetworkConfiguration

Designação	Descrição	Valor
Situação	Estado da rede para as sessões.	'EgressoDesativado' 'EgressEnabled'

SessionPoolProperties

Designação	Descrição	Valor
Tipo de contentor	O tipo de contêiner das sessões.	'CustomContainer' 'PythonLTS'
customContainerTemplate	A configuração de contêiner personalizada se 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ões.	string
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

Designação	Descrição	Valor
Designação	Nome secreto.	string
valor	Valor Secreto.	string Restrições: Valor sensível. Passe como um parâmetro seguro.

SessionRegistryCredentials

Designação	Descrição	Valor
identidade	Uma Identidade Gerenciada a ser usada para autenticar com o Registro de Contêiner do Azure. Para identidades atribuídas pelo usuário, use o ID de recurso de identidade atribuído pelo usuário completo. Para identidades atribuídas ao sistema, use 'system'	string
senhaSecretRef	O nome do segredo que contém a senha de login do Registro	string
servidor	Servidor de registro de contêiner.	string
nome de utilizador	Nome de usuário do registro de contêiner.	string

TrackedResourceTags

Designação	Descrição	Valor

Partilhar via

Microsoft.App sessionPools 2024-08-02-preview

Definição de recursos do bíceps

Formato do recurso

Valores de propriedade

CustomContainerTemplate

DynamicPoolConfiguration

AmbienteVar

Microsoft.App/sessionPools

ScaleConfiguration

SessionContainer

SessionContainerResources

SessionIngress

SessionNetworkConfiguration

SessionPoolProperties

SessionPoolSecret

SessionRegistryCredentials

TrackedResourceTags

Definição de recurso de modelo ARM

Formato do recurso

Valores de propriedade

CustomContainerTemplate

DynamicPoolConfiguration

AmbienteVar

Microsoft.App/sessionPools

ScaleConfiguration

SessionContainer

SessionContainerResources

SessionIngress

SessionNetworkConfiguration

SessionPoolProperties

SessionPoolSecret

SessionRegistryCredentials

TrackedResourceTags

Definição de recursos Terraform (provedor AzAPI)

Formato do recurso

Valores de propriedade

CustomContainerTemplate

DynamicPoolConfiguration

AmbienteVar

Microsoft.App/sessionPools

ScaleConfiguration

SessionContainer

SessionContainerResources

SessionIngress

SessionNetworkConfiguration

SessionPoolProperties

SessionPoolSecret

SessionRegistryCredentials

TrackedResourceTags

Comentários

Recursos adicionais