Jobs - Get

Serviço:: Azure Container Apps

Versão da API:: 2024-03-01

Obtenha 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 pattern: ^[-\w\._]+$	Nome do trabalho
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
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	Job	OKEY.
Other Status Codes	DefaultErrorResponse	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 Container Apps Job

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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 verificação de integridade a ser executada em um contêiner para determinar se ele está ativo ou pronto para receber tráfego.
ContainerResources	Requisitos de recurso de contêiner do Aplicativo de Contêiner.
createdByType	O tipo de identidade que criou o recurso.
DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.
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 de contêiner de init do Aplicativo de Contêiner
Job	Trabalho de Aplicativo de Contêiner
JobConfiguration	Propriedades de configuração do Trabalho de Aplicativos de Contêiner não com 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 versão do Trabalho de Aplicativos 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
ManagedServiceIdentity	Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário)
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (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 secreta.
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	O TCPSocket especifica uma ação envolvendo 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

Objeto

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 de contêiner.
volumeMounts	VolumeMount[]	Montagens de volume de contêiner.

ContainerAppProbe

Objeto

A investigação descreve uma verificação 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 (int32)	Falhas consecutivas mínimas para que a investigação seja considerada falha após ter sido bem-sucedida. O 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 (int32)	Número de segundos após o início do contêiner antes do início das investigações de atividade. O valor mínimo é 1. O valor máximo é 60.
periodSeconds	integer (int32)	Com que frequência (em segundos) executar a investigação. Padrão para 10 segundos. O valor mínimo é 1. O valor máximo é 240.
successThreshold	integer (int32)	Sucessos mínimos consecutivos para que a investigação seja considerada bem-sucedida após ter falhado. O padrão é 1. Deve ser 1 para animação e inicialização. O valor mínimo é 1. O valor máximo é 10.
tcpSocket	TcpSocket	O TCPSocket especifica uma ação envolvendo uma porta TCP. Ainda não há suporte para ganchos TCP.
terminationGracePeriodSeconds	integer (int64)	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 terminação 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 nulo, 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 eliminação (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 (int32)	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

Objeto

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

Nome	Tipo	Description
cpu	number (double)	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

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Objeto

Resposta de erro do Serviço de Aplicativo.

Nome	Tipo	Description
error	Error	Modelo de erro.

Details

Objeto

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

Objeto

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.

Error

Objeto

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 para depurar 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.

EventTriggerConfig

Objeto

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

Nome	Tipo	Description
parallelism	integer (int32)	Número de réplicas paralelas de um trabalho que pode ser executado em um determinado momento.
replicaCompletionCount	integer (int32)	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

Objeto

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 acesso no servidor HTTP.
port	integer (int32)	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

Objeto

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

Objeto

Definição de contêiner de init 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 de contêiner.
volumeMounts	VolumeMount[]	Montagens de volume de contêiner.

Job

Objeto

Trabalho de 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 por um trabalho de aplicativo de contêiner 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.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 de Aplicativos de Contêiner.
properties.workloadProfileName	string	Nome do perfil de carga de trabalho a ser fixado na execução do trabalho de aplicativos de contêiner.
systemData	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"

JobConfiguration

Objeto

Propriedades de configuração do Trabalho de Aplicativos de Contêiner não com 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 (int32)		Número máximo de tentativas antes de falhar no trabalho.
replicaTimeout	integer (int32)		O número máximo de segundos que uma réplica tem permissão para ser executada.
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

Enumeração

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

Valor	Description
InProgress
Succeeded
Failed
Canceled
Deleting

JobScale

Objeto

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

Nome	Tipo	Valor padrão	Description
maxExecutions	integer (int32)	100	Número máximo de execuções de trabalho que são criadas para um gatilho, padrão 100.
minExecutions	integer (int32)	0	Número mínimo de execuções de trabalho que são criadas para um gatilho, padrão 0
pollingInterval	integer (int32)		Intervalo para verificar cada fonte de evento em segundos. O padrão é 30s
rules	JobScaleRule[]		Regras de dimensionamento.

JobScaleRule

Objeto

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

Objeto

Definição de aplicativo com versão do Trabalho de Aplicativos 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

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

Objeto

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	ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).
userAssignedIdentities	<string, UserAssignedIdentity>	Identidades de 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

Enumeração

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

Valor	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

ManualTriggerConfig

Objeto

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 (int32)	Número de réplicas paralelas de um trabalho que pode ser executado em um determinado momento.
replicaCompletionCount	integer (int32)	Número mínimo de conclusões de réplica bem-sucedidas antes da conclusão geral do trabalho.

RegistryCredentials

Objeto

Registro Privado do Aplicativo de Contêiner

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

ScaleRuleAuth

Objeto

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 de gatilho que usa o segredo

ScheduleTriggerConfig

Objeto

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	Agenda de repetição formatada por cron ("* * * * * *") de um Trabalho Cron.
parallelism	integer (int32)	Número de réplicas paralelas de um trabalho que pode ser executado em um determinado momento.
replicaCompletionCount	integer (int32)	Número mínimo de conclusões de réplica bem-sucedidas antes da conclusão geral do trabalho.

Scheme

Enumeração

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

Valor	Description
HTTP
HTTPS

Secret

Objeto

Definição secreta.

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 do Azure Key Vault apontando para o segredo referenciado pelo aplicativo de contêiner.
name	string	Nome do segredo.
value	string	Valor secreto.

SecretVolumeItem

Objeto

Segredo a ser adicionado ao volume.

Nome	Tipo	Description
path	string	Caminho para o segredo do projeto. 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 extrair o valor do segredo.

StorageType

Enumeração

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

Valor	Description
AzureFile
EmptyDir
Secret

systemData

Objeto

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	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	createdByType	O tipo de identidade que modificou o recurso pela última vez.

TcpSocket

Objeto

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

Nome	Tipo	Description
host	string	Opcional: nome do host ao qual se conectar, o padrão é o IP do pod.
port	integer (int32)	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

Enumeração

Tipo de gatilho do trabalho

Valor	Description
Schedule
Event
Manual

Type

Enumeração

O tipo de investigação.

Valor	Description
Liveness
Readiness
Startup

UserAssignedIdentity

Objeto

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.

Volume

Objeto

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írgula.
name	string	Nome do volume.
secrets	SecretVolumeItem[]	Lista de segredos a serem adicionados no volume. Se nenhum segredo for fornecido, todos os segredos da 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

Objeto

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.