Jobs - Get

  • Referência
Service:
Azure Container Apps
API Version:
2024-03-01

Obter as propriedades de um Trabalho de Aplicativos de Contêiner.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}?api-version=2024-03-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
jobName
 path True

string

Nome do Trabalho

Regex pattern: ^[-\w\._\(\)]+$
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.

Respostas

Nome Tipo Description
200 OK

Job

OK.
Other Status Codes

DefaultErrorResponse

Resposta de erro comum.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

Get Container Apps Job

Sample Request

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0?api-version=2024-03-01

Sample Response

Status code:
200 
{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0",
  "name": "testcontainerappsjob0",
  "type": "Microsoft.App/jobs",
  "location": "East US",
  "properties": {
    "provisioningState": "Succeeded",
    "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube",
    "configuration": {
      "replicaTimeout": 10,
      "replicaRetryLimit": 10,
      "manualTriggerConfig": {
        "replicaCompletionCount": 1,
        "parallelism": 4
      },
      "triggerType": "Manual"
    },
    "template": {
      "containers": [
        {
          "image": "repo/testcontainerappsjob0:v4",
          "name": "testcontainerappsjob0",
          "resources": {
            "cpu": 0.5,
            "memory": "1Gi"
          }
        }
      ],
      "initContainers": [
        {
          "image": "repo/testcontainerappsjob0:v4",
          "name": "testinitcontainerAppsJob0",
          "resources": {
            "cpu": 0.5,
            "memory": "1Gi"
          }
        }
      ]
    }
  }
}

Definições

Nome Description
Container

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

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

Requisitos de recursos de contêiner do Aplicativo de Contêiner.
createdByType

O tipo de identidade que criou o recurso.
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.
EventTriggerConfig

Disparar a configuração de um trabalho controlado por eventos.
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.
InitContainer

Definição do contêiner de inicialização do Aplicativo de Contêiner
Job

Trabalho do Aplicativo de Contêiner
JobConfiguration

Propriedades de configuração de Trabalho de Aplicativos de Contêiner não com controle de versão
JobProvisioningState

Estado de provisionamento do Trabalho de Aplicativos de Contêiner.
JobScale

Configurações de dimensionamento para trabalhos controlados por eventos.
JobScaleRule

Regra de dimensionamento.
JobTemplate

Definição de aplicativo com controle de versão do Trabalho de Aplicativos de Contêiner. Define o estado desejado de uma revisão imutável. Todas as alterações nesta seção resultarão na criação de uma nova revisão
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 gerenciada (em que os tipos SystemAssigned e UserAssigned são permitidos).
ManualTriggerConfig

Configuração de gatilho manual para um único trabalho de execução. Propriedades replicaCompletionCount e paralelismo seriam definidos como 1 por padrão
RegistryCredentials

Registro Privado do Aplicativo de Contêiner
ScaleRuleAuth

Segredos de autenticação para regra de escala
ScheduleTriggerConfig

Agendamento de gatilho repetido formatado por cron ("* * * * *") para cronjobs. Conclusões de propriedades e paralelismo seriam definidos como 1 por padrão
Scheme

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

Definição de segredo.
SecretVolumeItem

Segredo a ser adicionado ao volume.
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 que envolve uma porta TCP. Ainda não há suporte para ganchos TCP.
TriggerType

Tipo de gatilho do trabalho
Type

O tipo de investigação.
UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário
Volume

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

Montagem de volume para o Aplicativo de Contêiner.

Container

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

Nome Tipo Description
args

string[]

Argumentos de comando de início de contêiner.
command

string[]

Comando de início do contêiner.
env

EnvironmentVar[]

Variáveis de ambiente de contêiner.
image

string

Marca de imagem de contêiner.
name

string

Nome do contêiner personalizado.
probes

ContainerAppProbe[]

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

ContainerResources

Requisitos de recursos do contêiner.
volumeMounts

VolumeMount[]

Montagens de volume de contêiner.

ContainerAppProbe

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

Nome Tipo Description
failureThreshold

integer

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

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 após ter falhado. O valor padrão é 1. Deve ser 1 para a vida e a inicialização. O valor mínimo é 1. O valor máximo é 10.
tcpSocket

TcpSocket

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

integer

Duração opcional em segundos em que o pod precisa terminar normalmente após a falha da investigação. O período de carência é a duração em segundos após os processos em execução no pod receberem um sinal de encerramento e a hora em que os processos são interrompidos à força com um sinal de encerramento. Defina esse valor por mais tempo do que o tempo de limpeza esperado para seu processo. Se esse valor for nulo, os terminationGracePeriodSeconds do pod serão usados. Caso contrário, esse valor substituirá o valor fornecido pela especificação de pod. O valor deve ser um inteiro não negativo. O valor zero indica parar imediatamente por meio do sinal de encerramento (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 investigação atinge o tempo limite. O padrão é 1 segundo. O valor mínimo é 1. O valor máximo é 240.
type

Type

O tipo de investigação.

ContainerResources

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

Nome Tipo 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.

Nome Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

DefaultErrorResponse

Serviço de Aplicativo resposta de erro.

Nome Tipo Description
error

Error

Modelo de erro.

Details

Detalhes ou o erro

Nome Tipo Description
code

string

Cadeia de caracteres padronizada para identificar programaticamente o erro.
message

string

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

string

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

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 efetuar pull do valor da variável de ambiente.
value

string

Valor da variável de ambiente não secreta.

Error

Modelo de erro.

Nome Tipo Description
code

string

Cadeia de caracteres padronizada para identificar programaticamente o erro.
details

Details[]

Detalhes ou o erro
innererror

string

Mais informações sobre o erro de depuração.
message

string

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

string

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

EventTriggerConfig

Disparar a configuração de um trabalho controlado por eventos.

Nome Tipo Description
parallelism

integer

Número de réplicas paralelas de um trabalho que pode ser executado em um determinado momento.
replicaCompletionCount

integer

Número mínimo de conclusões de réplica bem-sucedidas antes da conclusão geral do trabalho.
scale

JobScale

Configurações de dimensionamento para trabalhos controlados por eventos.

HttpGet

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

Nome Tipo Description
host

string

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

HttpHeaders[]

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

string

Caminho para acessar 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

Scheme

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

HttpHeaders

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

Nome Tipo Description
name

string

O nome do campo de cabeçalho
value

string

O valor do campo de cabeçalho

InitContainer

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

Nome Tipo Description
args

string[]

Argumentos de comando de início de contêiner.
command

string[]

Comando de início do contêiner.
env

EnvironmentVar[]

Variáveis de ambiente de contêiner.
image

string

Marca de imagem de contêiner.
name

string

Nome do contêiner personalizado.
resources

ContainerResources

Requisitos de recursos do contêiner.
volumeMounts

VolumeMount[]

Montagens de volume de contêiner.

Job

Trabalho do Aplicativo de Contêiner

Nome Tipo Description
id

string

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

ManagedServiceIdentity

Identidades gerenciadas necessárias para que um trabalho de aplicativo de contêiner interaja com outros serviços do Azure para não 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

JobConfiguration

Propriedades de configuração do Trabalho de Aplicativos de Contêiner.
properties.environmentId

string

ID do recurso do ambiente.
properties.eventStreamEndpoint

string

O ponto de extremidade do fluxo de eventos do trabalho de aplicativos de contêiner.
properties.outboundIpAddresses

string[]

Endereços IP de saída de um trabalho de aplicativos de contêiner.
properties.provisioningState

JobProvisioningState

Estado de provisionamento do Trabalho de Aplicativos de Contêiner.
properties.template

JobTemplate

Definição de trabalho dos Aplicativos de Contêiner.
properties.workloadProfileName

string

Nome do perfil de carga de trabalho a ser fixado para a execução do trabalho de aplicativos de contêiner.
systemData

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"

JobConfiguration

Propriedades de configuração de Trabalho de Aplicativos de Contêiner não com controle de versão

Nome Tipo Valor padrão Description
eventTriggerConfig

EventTriggerConfig

Disparar a configuração de um trabalho controlado por eventos.
manualTriggerConfig

ManualTriggerConfig

Configuração de gatilho manual para um único trabalho de execução. Propriedades replicaCompletionCount e paralelismo seriam definidos como 1 por padrão
registries

RegistryCredentials[]

Coleção de credenciais de registro de contêiner privado usadas por um trabalho de aplicativos de contêiner
replicaRetryLimit

integer

Número máximo de repetições antes de falhar o trabalho.
replicaTimeout

integer

Número máximo de segundos que um réplica tem permissão para executar.
scheduleTriggerConfig

ScheduleTriggerConfig

Agendamento de gatilho repetido formatado por cron ("* * * * *") para cronjobs. Conclusões de propriedades e paralelismo seriam definidos como 1 por padrão
secrets

Secret[]

Coleção de segredos usados por um trabalho de Aplicativos de Contêiner
triggerType

TriggerType

Manual

Tipo de gatilho do trabalho

JobProvisioningState

Estado de provisionamento do Trabalho de Aplicativos de Contêiner.

Nome Tipo Description
Canceled

string

Deleting

string

Failed

string

InProgress

string

Succeeded

string

JobScale

Configurações de dimensionamento para trabalhos controlados por eventos.

Nome Tipo Valor padrão Description
maxExecutions

integer

100

Número máximo de execuções de trabalho criadas para um gatilho, padrão 100.
minExecutions

integer

0

Número mínimo de execuções de trabalho criadas para um gatilho, padrão 0
pollingInterval

integer

Intervalo para marcar cada origem do evento em segundos. O padrão é 30s
rules

JobScaleRule[]

Regras de dimensionamento.

JobScaleRule

Regra de dimensionamento.

Nome Tipo Description
auth

ScaleRuleAuth[]

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

object

Propriedades de metadados para descrever a regra de escala.
name

string

Nome da regra de escala
type

string

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

JobTemplate

Definição de aplicativo com controle de versão do Trabalho de Aplicativos de Contêiner. Define o estado desejado de uma revisão imutável. Todas as alterações nesta seção resultarão na criação de uma nova revisão

Nome Tipo Description
containers

Container[]

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

InitContainer[]

Lista de contêineres especializados que são executados antes dos contêineres de aplicativo.
volumes

Volume[]

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

ManagedServiceIdentity

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

Nome Tipo 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

ManagedServiceIdentityType

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

<string,  UserAssignedIdentity>

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 formato: '/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 gerenciada (em que os tipos SystemAssigned e UserAssigned são permitidos).

Nome Tipo Description
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

ManualTriggerConfig

Configuração de gatilho manual para um único trabalho de execução. Propriedades replicaCompletionCount e paralelismo seriam definidos como 1 por padrão

Nome Tipo Description
parallelism

integer

Número de réplicas paralelas de um trabalho que pode ser executado em um determinado momento.
replicaCompletionCount

integer

Número mínimo de conclusões de réplica bem-sucedidas antes da conclusão geral do trabalho.

RegistryCredentials

Registro Privado do Aplicativo de Contêiner

Nome Tipo 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 de recurso de identidade atribuída pelo usuário completa. 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

ScaleRuleAuth

Segredos de autenticação para regra de escala

Nome Tipo Description
secretRef

string

Nome do segredo do qual efetuar pull dos parâmetros de autenticação.
triggerParameter

string

Parâmetro trigger que usa o segredo

ScheduleTriggerConfig

Agendamento de gatilho repetido formatado por cron ("* * * * *") para cronjobs. Conclusões de propriedades e paralelismo seriam definidos como 1 por padrão

Nome Tipo Description
cronExpression

string

Cron formatou a agenda de repetição ("* * * * * *") de um Trabalho Cron.
parallelism

integer

Número de réplicas paralelas de um trabalho que pode ser executado em um determinado momento.
replicaCompletionCount

integer

Número mínimo de conclusões de réplica bem-sucedidas antes da conclusão geral do trabalho.

Scheme

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

Nome Tipo Description
HTTP

string

HTTPS

string

Secret

Definição de segredo.

Nome Tipo Description
identity

string

ID de recurso de uma identidade gerenciada para autenticar com o Azure Key Vault ou o Sistema para usar uma identidade atribuída pelo sistema.
keyVaultUrl

string

URL de Key Vault do Azure apontando para o segredo referenciado pelo aplicativo de contêiner.
name

string

Nome do Segredo.
value

string

Valor do segredo.

SecretVolumeItem

Segredo a ser adicionado ao volume.

Nome Tipo Description
path

string

Caminho para o qual o segredo do projeto será projetado. Se nenhum caminho for fornecido, o caminho usará como padrão o nome do segredo listado em secretRef.
secretRef

string

Nome do segredo do Aplicativo de Contêiner do qual efetuar pull do valor do segredo.

StorageType

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

Nome Tipo Description
AzureFile

string

EmptyDir

string

Secret

string

systemData

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

Nome Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos (UTC).
createdBy

string

A identidade que criou o recurso.
createdByType

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

createdByType

O tipo de identidade que modificou o recurso pela última vez.

TcpSocket

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

Nome Tipo Description
host

string

Opcional: o nome do host ao qual se conectar, o padrão é 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.

TriggerType

Tipo de gatilho do trabalho

Nome Tipo Description
Event

string

Manual

string

Schedule

string

Type

O tipo de investigação.

Nome Tipo Description
Liveness

string

Readiness

string

Startup

string

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

Nome Tipo 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 de Contêiner.

Nome Tipo Description
mountOptions

string

Opções de montagem usadas durante a montagem do AzureFile. Deve ser uma cadeia de caracteres separada por vírgulas.
name

string

Nome do volume.
secrets

SecretVolumeItem[]

Lista de segredos a serem adicionados no volume. Se nenhum segredo for fornecido, todos os segredos na coleção serão adicionados ao volume.
storageName

string

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

StorageType

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

VolumeMount

Montagem de volume para o Aplicativo de Contêiner.

Nome Tipo Description
mountPath

string

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

string

Caminho dentro do volume do qual o volume do contêiner deve ser montado. O padrão é "" (raiz do volume).
volumeName

string

Isso deve corresponder ao Nome de um Volume.