Partilhar via


Jobs - List By Subscription

Obtenha as Tarefas das Aplicações de Contentor numa determinada subscrição.

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

Parâmetros do URI

Name Em Necessário Tipo Description
subscriptionId
path True

string

O ID da subscrição de destino.

api-version
query True

string

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

Respostas

Name Tipo Description
200 OK

JobsCollection

OK

Other Status Codes

DefaultErrorResponse

Resposta de erro.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

List Container Apps Jobs by subscription

Pedido de amostra

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

Resposta da amostra

{
  "value": [
    {
      "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"
              }
            }
          ]
        }
      }
    },
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob1",
      "name": "testcontainerappsjob1",
      "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,
          "scheduleTriggerConfig": {
            "replicaCompletionCount": 1,
            "cronExpression": "* * * * 5",
            "parallelism": 5
          },
          "triggerType": "Scheduled"
        },
        "template": {
          "containers": [
            {
              "image": "repo/testcontainerappsjob1:v4",
              "name": "testcontainerappsjob1",
              "resources": {
                "cpu": 0.5,
                "memory": "1Gi"
              }
            }
          ],
          "initContainers": [
            {
              "image": "repo/testcontainerappsjob1:v4",
              "name": "testinitcontainerAppsJob1",
              "resources": {
                "cpu": 0.5,
                "memory": "1Gi"
              }
            }
          ]
        }
      }
    }
  ],
  "nextLink": null
}

Definições

Name Description
Container

Definição de contentor da Aplicação contentora

ContainerAppProbe

A pesquisa descreve uma verificação de estado de funcionamento a ser efetuada num contentor para determinar se está viva ou pronta para receber tráfego.

ContainerResources

Requisitos de recursos de contentores da Aplicação de Contentor.

createdByType

O tipo de identidade que criou o recurso.

DefaultErrorResponse

Serviço de Aplicações resposta de erro.

Details

Detalhes ou o erro

EnvironmentVar

Variável de ambiente de contentor da Aplicação de Contentor.

Error

Modelo de erro.

EventTriggerConfig

Acionar a configuração de uma tarefa condicionada por eventos.

HttpGet

HTTPGet especifica o pedido http a executar.

HttpHeaders

Cabeçalhos personalizados a definir no pedido. HTTP permite cabeçalhos repetidos.

InitContainer

Definição de contentor init da Aplicação de Contentor

Job

Tarefa da Aplicação contentora

JobConfiguration

Propriedades de configuração da Tarefa de Aplicações de Contentor não com versões

JobProvisioningState

Estado de aprovisionamento da Tarefa de Aplicações de Contentor.

JobScale

Configurações de dimensionamento para tarefas condicionadas por eventos.

JobScaleRule

Regra de dimensionamento.

JobsCollection

Recurso ARM de coleção de Tarefas de Aplicações de Contentor.

JobTemplate

Definição da aplicação com versão de tarefa das Aplicações de Contentor. Define o estado pretendido de uma revisão imutável. Quaisquer alterações a esta secção resultarão na criação de uma nova revisão

ManagedServiceIdentity

Identidade de serviço gerida (identidades atribuídas pelo sistema e/ou pelo utilizador)

ManagedServiceIdentityType

Tipo de identidade de serviço gerida (onde os tipos SystemAssigned e UserAssigned são permitidos).

ManualTriggerConfig

Configuração manual do acionador para uma única tarefa de execução. As propriedades replicaCompletionCount e paralelismo seriam definidas como 1 por predefinição

RegistryCredentials

Registo Privado da Aplicação de Contentor

ScaleRuleAuth

Segredos de Autenticação para Regra de Dimensionamento

ScheduleTriggerConfig

Cron formatted repeating trigger schedule ("* * * * * *") for cronjobs. As conclusões de propriedades e o paralelismo seriam definidos como 1 por predefinição

Scheme

Esquema a utilizar para ligar ao anfitrião. Predefinições para HTTP.

Secret

Definição de segredo.

SecretVolumeItem

Segredo a adicionar ao volume.

StorageType

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

systemData

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

TcpSocket

TCPSocket especifica uma ação que envolve uma porta TCP. Os ganchos TCP ainda não são suportados.

TriggerType

Tipo de acionador da tarefa

Type

O tipo de sonda.

UserAssignedIdentity

Propriedades de identidade atribuídas pelo utilizador

Volume

Definições de volume para a Aplicação de Contentor.

VolumeMount

Montagem de volumes para a Aplicação de Contentor.

Container

Definição de contentor da Aplicação contentora

Name Tipo Description
args

string[]

Argumentos de comando de início do contentor.

command

string[]

Comando Iniciar contentor.

env

EnvironmentVar[]

Variáveis de ambiente de contentor.

image

string

Etiqueta de imagem de contentor.

name

string

Nome de contentor personalizado.

probes

ContainerAppProbe[]

Lista de sondas para o contentor.

resources

ContainerResources

Requisitos de recursos de contentor.

volumeMounts

VolumeMount[]

Montagens de volume de contentor.

ContainerAppProbe

A pesquisa descreve uma verificação de estado de funcionamento a ser efetuada num contentor para determinar se está viva ou pronta para receber tráfego.

Name Tipo Description
failureThreshold

integer

Falhas mínimas consecutivas para que a sonda seja considerada falhou depois de ter sido bem-sucedida. A predefinição é 3. O valor mínimo é 1. O valor máximo é 10.

httpGet

HttpGet

HTTPGet especifica o pedido http a executar.

initialDelaySeconds

integer

Número de segundos após o início do contentor antes de as pesquisas de liveness serem iniciadas. O valor mínimo é 1. O valor máximo é 60.

periodSeconds

integer

Com que frequência (em segundos) executar a sonda. Predefinição para 10 segundos. O valor mínimo é 1. O valor máximo é 240.

successThreshold

integer

Mínimo de êxitos consecutivos para que a sonda seja considerada com êxito depois de ter falhado. A predefinição é 1. Tem de ser 1 para liveness e arranque. O valor mínimo é 1. O valor máximo é 10.

tcpSocket

TcpSocket

TCPSocket especifica uma ação que envolve uma porta TCP. Os hooks TCP ainda não são suportados.

terminationGracePeriodSeconds

integer

Duração opcional em segundos, o pod tem de terminar corretamente após a falha da pesquisa. O período de tolerância é a duração em segundos após os processos em execução no pod serem enviados um sinal de terminação e o tempo em que os processos são interrompidos à força com um sinal de eliminação. Defina este valor mais longo do que o tempo de limpeza esperado para o seu processo. Se este valor for nulo, serão utilizados os terminaisGracePeriodSeconds do pod. Caso contrário, este valor substitui o valor fornecido pela especificação do pod. O valor tem de ser um número inteiro não negativo. O valor zero indica parar imediatamente através do sinal de eliminação (sem oportunidade de encerrar). Este é um campo alfa e requer a ativação da porta de funcionalidade ProbeTerminationGracePeriod. O valor máximo é 3600 segundos (1 hora)

timeoutSeconds

integer

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

type

Type

O tipo de sonda.

ContainerResources

Requisitos de recursos de contentores da Aplicação de Contentor.

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

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

DefaultErrorResponse

Serviço de Aplicações resposta de erro.

Name Tipo Description
error

Error

Modelo de erro.

Details

Detalhes ou o erro

Name Tipo Description
code

string

Cadeia padronizada para identificar programaticamente o erro.

message

string

Descrição detalhada do erro e informações de depuração.

target

string

Descrição detalhada do erro e informações de depuração.

EnvironmentVar

Variável de ambiente de contentor da Aplicação de Contentor.

Name Tipo Description
name

string

Nome da variável de ambiente.

secretRef

string

Nome do segredo da Aplicação de Contentor a partir do qual pretende extrair o valor da variável de ambiente.

value

string

Valor de variável de ambiente não secreto.

Error

Modelo de erro.

Name Tipo Description
code

string

Cadeia padronizada para identificar programaticamente o erro.

details

Details[]

Detalhes ou o erro

innererror

string

Mais informações para depurar o erro.

message

string

Descrição detalhada do erro e informações de depuração.

target

string

Descrição detalhada do erro e informações de depuração.

EventTriggerConfig

Acionar a configuração de uma tarefa condicionada por eventos.

Name Tipo Description
parallelism

integer

Número de réplicas paralelas de uma tarefa que pode ser executada num determinado momento.

replicaCompletionCount

integer

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

scale

JobScale

Configurações de dimensionamento para tarefas condicionadas por eventos.

HttpGet

HTTPGet especifica o pedido http a executar.

Name Tipo Description
host

string

O nome do anfitrião ao qual ligar, é predefinido para o IP do pod. É provável que pretenda definir "Anfitrião" em httpHeaders.

httpHeaders

HttpHeaders[]

Cabeçalhos personalizados a definir no pedido. HTTP permite cabeçalhos repetidos.

path

string

Caminho para o acesso no servidor HTTP.

port

integer

Nome ou número da porta a aceder no contentor. O número tem de estar no intervalo de 1 a 65535. O nome tem de ser um IANA_SVC_NAME.

scheme

Scheme

Esquema a utilizar para ligar ao anfitrião. A predefinição é HTTP.

HttpHeaders

Cabeçalhos personalizados a definir no pedido. HTTP permite cabeçalhos repetidos.

Name Tipo Description
name

string

O nome do campo de cabeçalho

value

string

O valor do campo de cabeçalho

InitContainer

Definição de contentor init da Aplicação de Contentor

Name Tipo Description
args

string[]

Argumentos de comando de início do contentor.

command

string[]

Comando Iniciar contentor.

env

EnvironmentVar[]

Variáveis de ambiente de contentor.

image

string

Etiqueta de imagem de contentor.

name

string

Nome de contentor personalizado.

resources

ContainerResources

Requisitos de recursos de contentor.

volumeMounts

VolumeMount[]

Montagens de volume de contentor.

Job

Tarefa da Aplicação contentora

Name Tipo Description
id

string

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

identity

ManagedServiceIdentity

Identidades geridas necessárias para uma tarefa de aplicação de contentor 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 reside o recurso

name

string

O nome do recurso

properties.configuration

JobConfiguration

Propriedades de configuração da Tarefa de Aplicações de Contentor.

properties.environmentId

string

ID de recurso do ambiente.

properties.eventStreamEndpoint

string

O ponto final do eventstream da tarefa de aplicações de contentor.

properties.outboundIpAddresses

string[]

Endereços IP de saída de uma tarefa de aplicações de contentor.

properties.provisioningState

JobProvisioningState

Estado de aprovisionamento da Tarefa de Aplicações de Contentor.

properties.template

JobTemplate

Definição de tarefa das Container Apps.

properties.workloadProfileName

string

Nome do perfil de carga de trabalho a afixar para execução de tarefas de aplicações de contentor.

systemData

systemData

O Azure Resource Manager metadados que contêm createdBy e modifiedBy information.

tags

object

Etiquetas de recursos.

type

string

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

JobConfiguration

Propriedades de configuração da Tarefa de Aplicações de Contentor não com versões

Name Tipo Default value Description
eventTriggerConfig

EventTriggerConfig

Acionar a configuração de uma tarefa condicionada por eventos.

manualTriggerConfig

ManualTriggerConfig

Configuração manual do acionador para uma única tarefa de execução. As propriedades replicaCompletionCount e paralelismo seriam definidas como 1 por predefinição

registries

RegistryCredentials[]

Coleção de credenciais de registo de contentor privadas utilizadas por uma tarefa de Aplicações de contentor

replicaRetryLimit

integer

Número máximo de tentativas antes de falhar a tarefa.

replicaTimeout

integer

Número máximo de segundos que uma réplica pode executar.

scheduleTriggerConfig

ScheduleTriggerConfig

Cron formatted repeating trigger schedule ("* * * * * *") for cronjobs. As conclusões de propriedades e o paralelismo seriam definidos como 1 por predefinição

secrets

Secret[]

Coleção de segredos utilizados por uma Tarefa de Aplicações de Contentor

triggerType

TriggerType

Manual

Tipo de acionador da tarefa

JobProvisioningState

Estado de aprovisionamento da Tarefa de Aplicações de Contentor.

Name Tipo Description
Canceled

string

Deleting

string

Failed

string

InProgress

string

Succeeded

string

JobScale

Configurações de dimensionamento para tarefas condicionadas por eventos.

Name Tipo Default value Description
maxExecutions

integer

100

Número máximo de execuções de tarefas criadas para um acionador, predefinição 100.

minExecutions

integer

0

Número mínimo de execuções de tarefas criadas para um acionador, predefinição 0

pollingInterval

integer

Intervalo para verificar cada origem de evento em segundos. Predefinições para 30s

rules

JobScaleRule[]

Regras de dimensionamento.

JobScaleRule

Regra de dimensionamento.

Name Tipo Description
auth

ScaleRuleAuth[]

Segredos de autenticação para a regra de dimensionamento.

metadata

object

Propriedades de metadados para descrever a regra de dimensionamento.

name

string

Dimensionar Nome da Regra

type

string

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

JobsCollection

Recurso ARM de coleção de Tarefas de Aplicações de Contentor.

Name Tipo Description
nextLink

string

Ligação para a página seguinte de recursos.

value

Job[]

Coleção de recursos.

JobTemplate

Definição da aplicação com versão de tarefa das Aplicações de Contentor. Define o estado pretendido de uma revisão imutável. Quaisquer alterações a esta secção resultarão na criação de uma nova revisão

Name Tipo Description
containers

Container[]

Lista de definições de contentor para a Aplicação de Contentor.

initContainers

InitContainer[]

Lista de contentores especializados que são executados antes dos contentores de aplicações.

volumes

Volume[]

Lista de definições de volume para a Aplicação de Contentor.

ManagedServiceIdentity

Identidade de serviço gerida (identidades atribuídas pelo sistema e/ou pelo utilizador)

Name Tipo Description
principalId

string

O ID do principal de serviço da identidade atribuída pelo sistema. Esta propriedade só será fornecida para uma identidade atribuída pelo sistema.

tenantId

string

O ID de inquilino da identidade atribuída pelo sistema. Esta propriedade só será fornecida para uma identidade atribuída pelo sistema.

type

ManagedServiceIdentityType

Tipo de identidade de serviço gerida (onde os tipos SystemAssigned e UserAssigned são permitidos).

userAssignedIdentities

<string,  UserAssignedIdentity>

Identidades de User-Assigned
O conjunto de identidades atribuídas pelo utilizador associadas ao recurso. As chaves de dicionário userAssignedIdentities serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) nos pedidos.

ManagedServiceIdentityType

Tipo de identidade de serviço gerida (onde os tipos SystemAssigned e UserAssigned são permitidos).

Name Tipo Description
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

ManualTriggerConfig

Configuração manual do acionador para uma única tarefa de execução. As propriedades replicaCompletionCount e paralelismo seriam definidas como 1 por predefinição

Name Tipo Description
parallelism

integer

Número de réplicas paralelas de uma tarefa que pode ser executada num determinado momento.

replicaCompletionCount

integer

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

RegistryCredentials

Registo Privado da Aplicação de Contentor

Name Tipo Description
identity

string

Uma Identidade Gerida a utilizar para autenticar com Azure Container Registry. Para identidades atribuídas pelo utilizador, utilize o ID de Recurso de identidade atribuída pelo utilizador completo. Para identidades atribuídas pelo sistema, utilize "system"

passwordSecretRef

string

O nome do Segredo que contém a palavra-passe de início de sessão do registo

server

string

Container Registry Server

username

string

Nome de Utilizador do Container Registry

ScaleRuleAuth

Segredos de Autenticação para Regra de Dimensionamento

Name Tipo Description
secretRef

string

Nome do segredo a partir do qual pretende extrair os parâmetros de autenticação.

triggerParameter

string

Parâmetro de Acionador que utiliza o segredo

ScheduleTriggerConfig

Cron formatted repeating trigger schedule ("* * * * * *") for cronjobs. As conclusões de propriedades e o paralelismo seriam definidos como 1 por predefinição

Name Tipo Description
cronExpression

string

Cron formatou a agenda de repetição ("* * * * *") de uma Tarefa cron.

parallelism

integer

Número de réplicas paralelas de uma tarefa que pode ser executada num determinado momento.

replicaCompletionCount

integer

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

Scheme

Esquema a utilizar para ligar ao anfitrião. Predefinições para HTTP.

Name Tipo Description
HTTP

string

HTTPS

string

Secret

Definição de segredo.

Name Tipo Description
identity

string

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

keyVaultUrl

string

URL do Azure Key Vault que aponta para o segredo referenciado pela aplicação de contentor.

name

string

Nome do Segredo.

value

string

Valor secreto.

SecretVolumeItem

Segredo a adicionar ao volume.

Name Tipo Description
path

string

Caminho para o segredo do projeto para. Se não for fornecido nenhum caminho, o caminho é predefinido para o nome do segredo listado em secretRef.

secretRef

string

Nome do segredo da Aplicação de Contentor a partir do qual pretende extrair o valor do segredo.

StorageType

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

Name Tipo Description
AzureFile

string

EmptyDir

string

Secret

string

systemData

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

Name 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. Os ganchos TCP ainda não são suportados.

Name Tipo Description
host

string

Opcional: o nome do anfitrião ao qual se ligar, é predefinido para o IP do pod.

port

integer

Número ou nome da porta a aceder no contentor. O número tem de estar entre 1 e 65535. O nome tem de ser um IANA_SVC_NAME.

TriggerType

Tipo de acionador da tarefa

Name Tipo Description
Event

string

Manual

string

Schedule

string

Type

O tipo de sonda.

Name Tipo Description
Liveness

string

Readiness

string

Startup

string

UserAssignedIdentity

Propriedades de identidade atribuídas pelo utilizador

Name Tipo Description
clientId

string

O ID de cliente da identidade atribuída.

principalId

string

O ID principal da identidade atribuída.

Volume

Definições de volume para a Aplicação de Contentor.

Name Tipo Description
mountOptions

string

Opções de montagem utilizadas durante a montagem do AzureFile. Tem de ser uma cadeia separada por vírgulas.

name

string

Nome do volume.

secrets

SecretVolumeItem[]

Lista de segredos a adicionar em volume. Se não forem fornecidos segredos, todos os segredos na coleção serão adicionados ao volume.

storageName

string

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

storageType

StorageType

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

VolumeMount

Montagem de volumes para a Aplicação de Contentor.

Name Tipo Description
mountPath

string

Caminho dentro do contentor no qual o volume deve ser montado. Não pode conter ":".

subPath

string

Caminho dentro do volume a partir do qual o volume do contentor deve ser montado. A predefinição é "" (raiz do volume).

volumeName

string

Isto tem de corresponder ao Nome de um Volume.