Container Apps - Update

Atualizar propriedades de um aplicativo de contêiner
Patches de um aplicativo de contêiner usando o Patch de Mesclagem JSON

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}?api-version=2022-03-01

Parâmetros de URI

Name In Required Type Description
containerAppName
path True
  • string

Nome do Aplicativo de Contêiner.

resourceGroupName
path True
  • string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

subscriptionId
path True
  • string

A ID da assinatura de destino.

api-version
query True
  • string

A versão da API a ser usada para esta operação.

Corpo da solicitação

Name Required Type Description
location True
  • string

A localização geográfica onde o recurso reside

identity

identidades gerenciadas para o Aplicativo de Contêiner interagir com outros serviços do Azure sem manter segredos ou credenciais no código.

properties.configuration

Propriedades de configuração do Aplicativo de Contêiner não com versão.

properties.managedEnvironmentId
  • string

ID do recurso do ambiente do Aplicativo de Contêiner.

properties.template

Definição de aplicativo com versão do Aplicativo de Contêiner.

tags
  • object

Marcas de recurso.

Respostas

Name Type Description
202 Accepted

A operação de patch está em andamento.

Other Status Codes

Resposta de erro comum.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

Patch Container App

Sample Request

PATCH https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0?api-version=2022-03-01

{
  "location": "East US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "configuration": {
      "ingress": {
        "external": true,
        "targetPort": 3000,
        "customDomains": [
          {
            "name": "www.my-name.com",
            "bindingType": "SniEnabled",
            "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com"
          },
          {
            "name": "www.my-other-name.com",
            "bindingType": "SniEnabled",
            "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com"
          }
        ],
        "traffic": [
          {
            "weight": 100,
            "revisionName": "testcontainerApp0-ab1234",
            "label": "production"
          }
        ]
      },
      "dapr": {
        "enabled": true,
        "appPort": 3000,
        "appProtocol": "http"
      }
    },
    "template": {
      "containers": [
        {
          "image": "repo/testcontainerApp0:v1",
          "name": "testcontainerApp0",
          "probes": [
            {
              "type": "Liveness",
              "httpGet": {
                "path": "/health",
                "port": 8080,
                "httpHeaders": [
                  {
                    "name": "Custom-Header",
                    "value": "Awesome"
                  }
                ]
              },
              "initialDelaySeconds": 3,
              "periodSeconds": 3
            }
          ]
        }
      ],
      "scale": {
        "minReplicas": 1,
        "maxReplicas": 5,
        "rules": [
          {
            "name": "httpscalingrule",
            "custom": {
              "type": "http",
              "metadata": {
                "concurrentRequests": "50"
              }
            }
          }
        ]
      }
    }
  }
}

Sample Response

azure-asyncoperation: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/locations/eastus/containerappOperationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-03-01

Definições

ActiveRevisionsMode

ActiveRevisionsMode controla como as revisões ativas são tratadas para o aplicativo Contêiner: várias: várias revisões podem estar ativas. Único: apenas uma revisão pode estar ativa por vez. Os pesos de revisão não podem ser usados nesse modo. Se nenhum valor for fornecido, esse será o padrão.

appProtocol

Informa ao Dapr qual protocolo seu aplicativo está usando. As opções válidas são http e grpc. O padrão é http

bindingType

Custom Domain tipo de associação.

Configuration

Propriedades de configuração do Aplicativo de Contêiner não com versão que definem as configurações mutáveis de um aplicativo contêiner

Container

Definição de contêiner do Aplicativo de Contêiner.

ContainerApp

Aplicativo contêiner.

ContainerAppProbe

A investigação descreve uma verificação de integridade a ser executada em um contêiner para determinar se ele está vivo ou pronto para receber tráfego.

ContainerAppProvisioningState

Estado de provisionamento do Aplicativo de Contêiner.

ContainerResources

Requisitos de recurso de contêiner do Aplicativo de Contêiner.

createdByType

O tipo de identidade que criou o recurso.

CustomDomain

Custom Domain de um aplicativo de contêiner

CustomScaleRule

Regra de dimensionamento personalizada do contêiner do Aplicativo de Contêiner.

Dapr

Configuração do Dapr do Aplicativo de Contêiner.

DefaultErrorResponse

Serviço de Aplicativo resposta de erro.

Details

Detalhes ou o erro

EnvironmentVar

Variável de ambiente de contêiner do Aplicativo de Contêiner.

Error

Modelo de erro.

HttpGet

HTTPGet especifica a solicitação http a ser executada.

HttpHeaders

Cabeçalhos personalizados a serem definidos na solicitação. HTTP permite cabeçalhos repetidos.

HttpScaleRule

Regra de dimensionamento personalizada do contêiner do Aplicativo de Contêiner.

Ingress

Configuração de Entrada do Aplicativo de Contêiner.

IngressTransportMethod

Protocolo de transporte de entrada

ManagedServiceIdentity

Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou atribuídas pelo usuário)

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).

QueueScaleRule

Regra de dimensionamento baseada em Fila do Azure do contêiner de Aplicativo de Contêiner.

RegistryCredentials

Registro Privado do Aplicativo de Contêiner

Scale

Configurações de dimensionamento do Aplicativo de Contêiner.

ScaleRule

Regra de dimensionamento de contêiner do Aplicativo de Contêiner.

ScaleRuleAuth

Auth Secrets for Container App Scale Rule

Scheme

Esquema a ser usado para se conectar ao host. O padrão é HTTP.

Secret

Definição secreta.

StorageType

Tipo de armazenamento para o volume. Se não for fornecido, use EmptyDir.

systemData

Metadados relativos à criação e à última modificação do recurso.

TcpSocket

TCPSocket especifica uma ação envolvendo uma porta TCP. Ainda não há suporte para ganchos TCP.

Template

Definição de aplicativo com versão do Aplicativo de Contêiner. Define o estado desejado de uma revisão imutável. Qualquer alteração nesta seção resultará na criação de uma nova revisão

TrafficWeight

Peso do tráfego atribuído a uma revisão

Type

O tipo de investigação.

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

Volume

Definições de volume para o Aplicativo contêiner.

VolumeMount

Montagem de volume para o Aplicativo de Contêiner.

ActiveRevisionsMode

ActiveRevisionsMode controla como as revisões ativas são tratadas para o aplicativo Contêiner: várias: várias revisões podem estar ativas. Único: apenas uma revisão pode estar ativa por vez. Os pesos de revisão não podem ser usados nesse modo. Se nenhum valor for fornecido, esse será o padrão.

Name Type Description
Multiple
  • string
Single
  • string

appProtocol

Informa ao Dapr qual protocolo seu aplicativo está usando. As opções válidas são http e grpc. O padrão é http

Name Type Description
grpc
  • string
http
  • string

bindingType

Custom Domain tipo de associação.

Name Type Description
Disabled
  • string
SniEnabled
  • string

Configuration

Propriedades de configuração do Aplicativo de Contêiner não com versão que definem as configurações mutáveis de um aplicativo contêiner

Name Type Description
activeRevisionsMode

ActiveRevisionsMode controla como as revisões ativas são tratadas para o aplicativo Contêiner: várias: várias revisões podem estar ativas. Único: apenas uma revisão pode estar ativa por vez. Os pesos de revisão não podem ser usados nesse modo. Se nenhum valor for fornecido, esse será o padrão.

dapr

Configuração dapr para o Aplicativo contêiner.

ingress

Configurações de entrada.

registries

Coleção de credenciais de registro de contêiner privado para contêineres usados pelo aplicativo Contêiner

secrets

Coleção de segredos usados por um aplicativo contêiner

Container

Definição de contêiner do Aplicativo de Contêiner.

Name Type 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 do contêiner.

name
  • string

Nome do contêiner personalizado.

probes

Lista de investigações para o contêiner.

resources

Requisitos de recursos do contêiner.

volumeMounts

Montagens de volume de contêiner.

ContainerApp

Aplicativo contêiner.

Name Type Description
id
  • string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

identidades gerenciadas para o Aplicativo de Contêiner interagir com outros serviços do Azure sem manter segredos ou credenciais no código.

location
  • string

A localização geográfica em que o recurso reside

name
  • string

O nome do recurso

properties.configuration

Propriedades de configuração do Aplicativo de Contêiner não com versão.

properties.customDomainVerificationId
  • string

Id usada para verificar a propriedade do nome de domínio

properties.latestRevisionFqdn
  • string

Nome de domínio totalmente qualificado da última revisão do Aplicativo de Contêiner.

properties.latestRevisionName
  • string

Nome da última revisão do Aplicativo de Contêiner.

properties.managedEnvironmentId
  • string

ID do recurso do ambiente do Aplicativo de Contêiner.

properties.outboundIPAddresses
  • string[]

Endereços IP de saída para o aplicativo de contêiner.

properties.provisioningState

Estado de provisionamento do Aplicativo de Contêiner.

properties.template

Definição de aplicativo com versão do Aplicativo de Contêiner.

systemData

Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.

tags
  • object

Marcas de recurso.

type
  • string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ContainerAppProbe

A investigação descreve uma verificação de integridade a ser executada em um contêiner para determinar se ele está vivo ou pronto para receber tráfego.

Name Type Description
failureThreshold
  • integer

Falhas consecutivas mínimas para que a investigação seja considerada com falha após ter sido bem-sucedida. O valor padrão é 3. O valor mínimo é 1. O valor máximo é 10.

httpGet

HTTPGet especifica a solicitação http a ser executada.

initialDelaySeconds
  • integer

Número de segundos depois que o contêiner é iniciado antes que as investigações de atividade sejam iniciadas. O valor mínimo é 1. O valor máximo é 60.

periodSeconds
  • integer

A frequência (em segundos) para realizar a investigação. O padrão é 10 segundos. O valor mínimo é 1. O valor máximo é 240.

successThreshold
  • integer

Mínimo de sucessos consecutivos para que a investigação seja considerada bem-sucedida depois de ter falhado. O valor padrão é 1. Deve ser 1 para animação e inicialização. O valor mínimo é 1. O valor máximo é 10.

tcpSocket

TCPSocket especifica uma ação envolvendo uma porta TCP. Ainda não há suporte para ganchos TCP.

terminationGracePeriodSeconds
  • integer

Duração opcional em segundos, o pod precisa terminar normalmente após a falha da investigação. O período de carência é a duração em segundos depois que os processos em execução no pod são enviados um sinal de encerramento e a hora em que os processos são interrompidos à força com um sinal de morte. Defina esse valor por mais tempo do que o tempo de limpeza esperado para o processo. Se esse valor for zero, os terminationGracePeriodSeconds do pod serão usados. Caso contrário, esse valor substituirá o valor fornecido pela especificação do pod. O valor deve ser inteiro não negativo. O valor zero indica parar imediatamente por meio do sinal de morte (sem oportunidade de desligar). Esse é um campo alfa e requer a habilitação do portão de recursos ProbeTerminationGracePeriod. O valor máximo é de 3600 segundos (1 hora)

timeoutSeconds
  • integer

Número de segundos após o qual a sonda atinge o tempo limite. O padrão é 1 segundo. O valor mínimo é 1. O valor máximo é 240.

type

O tipo de investigação.

ContainerAppProvisioningState

Estado de provisionamento do Aplicativo de Contêiner.

Name Type Description
Canceled
  • string
Deleting
  • string
Failed
  • string
InProgress
  • string
Succeeded
  • string

ContainerResources

Requisitos de recurso de contêiner do Aplicativo de Contêiner.

Name Type Description
cpu
  • number

CPU necessária em núcleos, por exemplo, 0,5

ephemeralStorage
  • string

Armazenamento Efêmero, por exemplo, "1Gi"

memory
  • string

Memória necessária, por exemplo, "250 Mb"

createdByType

O tipo de identidade que criou o recurso.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

CustomDomain

Custom Domain de um aplicativo de contêiner

Name Type Description
bindingType

Custom Domain tipo de associação.

certificateId
  • string

ID do recurso do Certificado a ser associado a esse nome de host. Deve existir no Ambiente Gerenciado.

name
  • string

Hostname.

CustomScaleRule

Regra de dimensionamento personalizada do contêiner do Aplicativo de Contêiner.

Name Type Description
auth

Segredos de autenticação para a regra de escala personalizada.

metadata
  • object

Propriedades de metadados para descrever a regra de escala personalizada.

type
  • string

Tipo da regra de escala personalizada, por exemplo: azure-servicebus, redis etc.

Dapr

Configuração do Dapr do Aplicativo de Contêiner.

Name Type Description
appId
  • string

Identificador de aplicativo Dapr

appPort
  • integer

Informa à Dapr em qual porta seu aplicativo está escutando

appProtocol

Informa ao Dapr qual protocolo seu aplicativo está usando. As opções válidas são http e grpc. O padrão é http

enabled
  • boolean

Booliano indicando se o carro lateral dapr está habilitado

DefaultErrorResponse

Serviço de Aplicativo resposta de erro.

Name Type Description
error

Modelo de erro.

Details

Detalhes ou o erro

Name Type Description
code
  • string

Cadeia de caracteres padronizada para identificar programaticamente o erro.

message
  • string

Informações detalhadas de descrição e depuração de erro.

target
  • string

Informações detalhadas de descrição e depuração de erro.

EnvironmentVar

Variável de ambiente de contêiner do Aplicativo de Contêiner.

Name Type 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.

Error

Modelo de erro.

Name Type Description
code
  • string

Cadeia de caracteres padronizada para identificar programaticamente o erro.

details

Detalhes ou o erro

innererror
  • string

Mais informações para depurar o erro.

message
  • string

Informações detalhadas de descrição e depuração de erro.

target
  • string

Informações detalhadas de descrição e depuração de erro.

HttpGet

HTTPGet especifica a solicitação http a ser executada.

Name Type Description
host
  • string

O nome do host ao qual se conectar, padrão, é o IP do pod. Você provavelmente deseja definir "Host" em httpHeaders.

httpHeaders

Cabeçalhos personalizados a serem definidos na solicitação. HTTP permite cabeçalhos repetidos.

path
  • string

Caminho para acesso no servidor HTTP.

port
  • integer

Nome ou número da porta a ser acessada no contêiner. O número deve estar no intervalo de 1 a 65535. O nome deve ser um IANA_SVC_NAME.

scheme

Esquema a ser usado para se conectar ao host. Padrão para HTTP.

HttpHeaders

Cabeçalhos personalizados a serem definidos na solicitação. HTTP permite cabeçalhos repetidos.

Name Type Description
name
  • string

O nome do campo de cabeçalho

value
  • string

O valor do campo de cabeçalho

HttpScaleRule

Regra de dimensionamento personalizada do contêiner do Aplicativo de Contêiner.

Name Type Description
auth

Segredos de autenticação para a regra de escala personalizada.

metadata
  • object

Propriedades de metadados para descrever a regra de escala http.

Ingress

Configuração de Entrada do Aplicativo de Contêiner.

Name Type Default Value Description
allowInsecure
  • boolean

Bool indicando se as conexões HTTP são permitidas. Se definidas como conexões HTTP falsas forem redirecionadas automaticamente para conexões HTTPS

customDomains

associações de domínio personalizadas para nomes de host dos Aplicativos de Contêiner.

external
  • boolean
False

Bool indicando se o aplicativo expõe um ponto de extremidade http externo

fqdn
  • string

Hostname.

targetPort
  • integer

Porta de destino em contêineres para tráfego de entrada

traffic

Pesos de tráfego para revisões do aplicativo

transport

Protocolo de transporte de entrada

IngressTransportMethod

Protocolo de transporte de entrada

Name Type Description
auto
  • string
http
  • string
http2
  • string

ManagedServiceIdentity

Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou atribuídas pelo usuário)

Name Type Description
principalId
  • string

A ID da entidade de serviço da identidade atribuída pelo sistema. Essa propriedade só será fornecida para uma identidade atribuída pelo sistema.

tenantId
  • string

A ID do locatário da identidade atribuída pelo sistema. Essa propriedade só será fornecida 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

identidades User-Assigned
O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) em solicitações.

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

QueueScaleRule

Regra de dimensionamento baseada em Fila do Azure do contêiner de Aplicativo de Contêiner.

Name Type Description
auth

Segredos de autenticação para a regra de escala de fila.

queueLength
  • integer

Comprimento da fila.

queueName
  • string

Nome da fila.

RegistryCredentials

Registro Privado do Aplicativo de Contêiner

Name Type Description
identity
  • string

Uma Identidade Gerenciada a ser usada para autenticar com Registro de Contêiner do Azure. Para identidades atribuídas pelo usuário, use a ID completa de 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

Scale

Configurações de dimensionamento do Aplicativo de Contêiner.

Name Type Description
maxReplicas
  • integer

Opcional. Número máximo de réplicas de contêiner. O padrão será 10 se não estiver definido.

minReplicas
  • integer

Opcional. Número mínimo de réplicas de contêiner.

rules

Regras de dimensionamento.

ScaleRule

Regra de dimensionamento de contêiner do Aplicativo de Contêiner.

Name Type Description
azureQueue

Dimensionamento baseado em Fila do Azure.

custom

Regra de escala personalizada.

http

Dimensionamento baseado em solicitações HTTP.

name
  • string

Nome da regra de escala

ScaleRuleAuth

Auth Secrets for Container App Scale Rule

Name Type Description
secretRef
  • string

Nome do segredo do Aplicativo de Contêiner do qual extrair os params de autenticação.

triggerParameter
  • string

Parâmetro de gatilho que usa o segredo

Scheme

Esquema a ser usado para se conectar ao host. O padrão é HTTP.

Name Type Description
HTTP
  • string
HTTPS
  • string

Secret

Definição secreta.

Name Type Description
name
  • string

Nome do Segredo.

value
  • string

Valor secreto.

StorageType

Tipo de armazenamento para o volume. Se não for fornecido, use EmptyDir.

Name Type Description
AzureFile
  • string
EmptyDir
  • string

systemData

Metadados relativos à criação e à última modificação do recurso.

Name Type Description
createdAt
  • string

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

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.

TcpSocket

TCPSocket especifica uma ação envolvendo uma porta TCP. Ainda não há suporte para ganchos TCP.

Name Type Description
host
  • string

Opcional: o nome do host ao qual se conectar, é padrão para o IP do pod.

port
  • integer

Número ou nome da porta a ser acessada no contêiner. O número deve estar no intervalo de 1 a 65535. O nome deve ser um IANA_SVC_NAME.

Template

Definição de aplicativo com versão do Aplicativo de Contêiner. Define o estado desejado de uma revisão imutável. Qualquer alteração nesta seção resultará na criação de uma nova revisão

Name Type Description
containers

Lista de definições de contêiner para o Aplicativo de Contêiner.

revisionSuffix
  • string

Sufixo amigável que é acrescentado ao nome de revisão

scale

Dimensionamento de propriedades para o Aplicativo de Contêiner.

volumes

Lista de definições de volume para o Aplicativo de Contêiner.

TrafficWeight

Peso do tráfego atribuído a uma revisão

Name Type Default Value Description
label
  • string

Associa um rótulo de tráfego a uma revisão

latestRevision
  • boolean
False

Indica que o peso do tráfego pertence a uma revisão estável mais recente

revisionName
  • string

Nome de uma revisão

weight
  • integer

Peso do tráfego atribuído a uma revisão

Type

O tipo de investigação.

Name Type Description
Liveness
  • string
Readiness
  • string
Startup
  • string

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

Name Type Description
clientId
  • string

A ID do cliente da identidade atribuída.

principalId
  • string

A ID da entidade de segurança da identidade atribuída.

Volume

Definições de volume para o Aplicativo contêiner.

Name Type Description
name
  • string

Nome do volume.

storageName
  • string

Nome do recurso de armazenamento. Não é necessário fornecer para EmptyDir.

storageType

Tipo de armazenamento para o volume. Se não for fornecido, use EmptyDir.

VolumeMount

Montagem de volume para o Aplicativo de Contêiner.

Name Type Description
mountPath
  • string

Caminho dentro do contêiner no qual o volume deve ser montado. Não deve conter ':'.

volumeName
  • string

Isso deve corresponder ao nome de um volume.