Jobs - Get

Referencia

Service:: Azure Container Apps

API Version:: 2024-03-01

Obtenga las propiedades de un trabajo de Container Apps.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
jobName	path	True	string	Nombre del trabajo Regex pattern: `^[-\w\._]+$`
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	Job	Aceptar.
Other Status Codes	DefaultErrorResponse	Respuesta de error común.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Get Container Apps Job

Sample Request

HTTP

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"
          }
        }
      ]
    }
  }
}

Definiciones

Nombre	Description
Container	Definición de contenedor de la aplicación contenedora
ContainerAppProbe	El sondeo describe una comprobación de estado que se va a realizar en un contenedor para determinar si está activo o listo para recibir tráfico.
ContainerResources	Requisitos de recursos de contenedor de container App.
createdByType	Tipo de identidad que creó el recurso.
DefaultErrorResponse	App Service respuesta de error.
Details	Detalles o el error
EnvironmentVar	Variable de entorno de contenedor de la aplicación contenedora.
Error	Modelo de error.
EventTriggerConfig	Desencadene la configuración de un trabajo controlado por eventos.
HttpGet	HTTPGet especifica la solicitud HTTP que se va a realizar.
HttpHeaders	Encabezados personalizados que se van a establecer en la solicitud. HTTP permite encabezados repetidos.
InitContainer	Definición de contenedor de inicialización de aplicación de contenedor
Job	Trabajo de aplicación de contenedor
JobConfiguration	Propiedades de configuración del trabajo de Aplicaciones de contenedor no con versiones
JobProvisioningState	Estado de aprovisionamiento del trabajo de aplicaciones de contenedor.
JobScale	Escalado de configuraciones para trabajos controlados por eventos.
JobScaleRule	Regla de escalado.
JobTemplate	Definición de aplicación con versiones del trabajo de Container Apps. Define el estado deseado de una revisión inmutable. Los cambios realizados en esta sección darán lugar a que se cree una nueva revisión.
ManagedServiceIdentity	Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario)
ManagedServiceIdentityType	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).
ManualTriggerConfig	Configuración manual del desencadenador para un único trabajo de ejecución. Las propiedades replicaCompletionCount y paralelismo se establecerían en 1 de forma predeterminada.
RegistryCredentials	Registro privado de la aplicación contenedora
ScaleRuleAuth	Secretos de autenticación para la regla de escalado
ScheduleTriggerConfig	Programación de desencadenador de repetición con formato Cron ("* * * * * *") para cronjobs. Las finalizaciones de propiedades y el paralelismo se establecerían en 1 de forma predeterminada.
Scheme	Esquema que se va a usar para conectarse al host. El valor predeterminado es HTTP.
Secret	Definición de secreto.
SecretVolumeItem	Secreto que se va a agregar al volumen.
StorageType	Tipo de almacenamiento para el volumen. Si no se proporciona, use EmptyDir.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
TcpSocket	TCPSocket especifica una acción que implica un puerto TCP. Todavía no se admiten enlaces TCP.
TriggerType	Tipo de desencadenador del trabajo
Type	Tipo de sondeo.
UserAssignedIdentity	Propiedades de identidad asignadas por el usuario
Volume	Definiciones de volumen para la aplicación contenedora.
VolumeMount	Montaje de volumen para la aplicación contenedora.

Container

Definición de contenedor de la aplicación contenedora

Nombre	Tipo	Description
args	string[]	Argumentos de comando de inicio de contenedor.
command	string[]	Comando de inicio del contenedor.
env	EnvironmentVar[]	Variables de entorno de contenedor.
image	string	Etiqueta de imagen de contenedor.
name	string	Nombre del contenedor personalizado.
probes	ContainerAppProbe[]	Lista de sondeos para el contenedor.
resources	ContainerResources	Requisitos de recursos de contenedor.
volumeMounts	VolumeMount[]	Montajes de volumen de contenedor.

ContainerAppProbe

El sondeo describe una comprobación de estado que se va a realizar en un contenedor para determinar si está activo o listo para recibir tráfico.

Nombre	Tipo	Description
failureThreshold	integer	Se han producido errores consecutivos mínimos para que el sondeo se considere erróneo después de haber realizado correctamente. El valor predeterminado es 3. El valor mínimo es 1. El valor máximo es 10.
httpGet	HttpGet	HTTPGet especifica la solicitud HTTP que se va a realizar.
initialDelaySeconds	integer	Número de segundos después de que se haya iniciado el contenedor antes de que se inicien los sondeos de ejecución. El valor mínimo es 1. El valor máximo es 60.
periodSeconds	integer	Frecuencia (en segundos) con que se ejecutará el sondeo. El valor predeterminado es de 10 segundos. El valor mínimo es 1. El valor máximo es 240.
successThreshold	integer	Número mínimo de éxitos consecutivos para que el sondeo se considere correcto después de haber producido un error. De manera predeterminada, su valor es 1. Debe ser 1 para la vida y el inicio. El valor mínimo es 1. El valor máximo es 10.
tcpSocket	TcpSocket	TCPSocket especifica una acción que implica un puerto TCP. Todavía no se admiten enlaces TCP.
terminationGracePeriodSeconds	integer	Duración opcional en segundos que el pod debe finalizar correctamente tras un error de sondeo. El período de gracia es la duración en segundos después de que los procesos que se ejecutan en el pod se envíen una señal de terminación y el tiempo en que los procesos se detengan forzosamente con una señal de eliminación. Establezca este valor más largo que el tiempo de limpieza esperado para el proceso. Si este valor es nulo, se usará la terminación del podGracePeriodSeconds. De lo contrario, este valor invalida el valor proporcionado por la especificación del pod. El valor debe ser entero no negativo. El valor cero indica que se detiene inmediatamente a través de la señal de eliminación (sin oportunidad de apagar). Se trata de un campo alfa y requiere habilitar la puerta de características ProbeTerminationGracePeriod. El valor máximo es de 3600 segundos (1 hora)
timeoutSeconds	integer	Número de segundos después del cual se agota el tiempo de espera del sondeo. El valor predeterminado es 1 segundo. El valor mínimo es 1. El valor máximo es 240.
type	Type	Tipo de sondeo.

ContainerResources

Requisitos de recursos de contenedor de container App.

Nombre	Tipo	Description
cpu	number	CPU necesaria en núcleos, por ejemplo, 0,5
ephemeralStorage	string	Almacenamiento efímero, por ejemplo, "1Gi"
memory	string	Memoria necesaria, por ejemplo, "250 Mb"

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultErrorResponse

App Service respuesta de error.

Nombre	Tipo	Description
error	Error	Modelo de error.

Details

Detalles o el error

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

EnvironmentVar

Variable de entorno de contenedor de la aplicación contenedora.

Nombre	Tipo	Description
name	string	Nombre de la variable de entorno.
secretRef	string	Nombre del secreto de la aplicación contenedora del que se va a extraer el valor de la variable de entorno.
value	string	Valor de variable de entorno no secreto.

Error

Modelo de error.

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
details	Details[]	Detalles o el error
innererror	string	Más información para depurar el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

EventTriggerConfig

Desencadene la configuración de un trabajo controlado por eventos.

Nombre	Tipo	Description
parallelism	integer	Número de réplicas paralelas de un trabajo que se puede ejecutar en un momento dado.
replicaCompletionCount	integer	Número mínimo de finalizaciones de réplica correctas antes de la finalización general del trabajo.
scale	JobScale	Escalado de configuraciones para trabajos controlados por eventos.

HttpGet

HTTPGet especifica la solicitud HTTP que se va a realizar.

Nombre	Tipo	Description
host	string	Nombre de host al que conectarse, el valor predeterminado es la dirección IP del pod. Probablemente quiera establecer "Host" en httpHeaders en su lugar.
httpHeaders	HttpHeaders[]	Encabezados personalizados que se van a establecer en la solicitud. HTTP permite encabezados repetidos.
path	string	Ruta de acceso al acceso en el servidor HTTP.
port	integer	Nombre o número del puerto al que se va a acceder en el contenedor. El número debe estar en el intervalo de 1 a 65535. El nombre debe ser un IANA_SVC_NAME.
scheme	Scheme	Esquema que se va a usar para conectarse al host. El valor predeterminado es HTTP.

HttpHeaders

Encabezados personalizados que se van a establecer en la solicitud. HTTP permite encabezados repetidos.

Nombre	Tipo	Description
name	string	Nombre del campo de encabezado
value	string	Valor del campo de encabezado

InitContainer

Definición de contenedor de inicialización de aplicación de contenedor

Nombre	Tipo	Description
args	string[]	Argumentos de comando de inicio de contenedor.
command	string[]	Comando de inicio del contenedor.
env	EnvironmentVar[]	Variables de entorno de contenedor.
image	string	Etiqueta de imagen de contenedor.
name	string	Nombre del contenedor personalizado.
resources	ContainerResources	Requisitos de recursos de contenedor.
volumeMounts	VolumeMount[]	Montajes de volumen de contenedor.

Job

Trabajo de aplicación de contenedor

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Identidades administradas necesarias para que un trabajo de aplicación de contenedor interactúe con otros servicios de Azure para no mantener secretos ni credenciales en el código.
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso.
properties.configuration	JobConfiguration	Propiedades de configuración del trabajo de Container Apps.
properties.environmentId	string	Identificador de recurso del entorno.
properties.eventStreamEndpoint	string	Punto de conexión del flujo de eventos del trabajo de aplicaciones de contenedor.
properties.outboundIpAddresses	string[]	Direcciones IP salientes de un trabajo de aplicaciones de contenedor.
properties.provisioningState	JobProvisioningState	Estado de aprovisionamiento del trabajo de aplicaciones de contenedor.
properties.template	JobTemplate	Definición de trabajo de Container Apps.
properties.workloadProfileName	string	Nombre del perfil de carga de trabajo que se va a anclar para la ejecución del trabajo de las aplicaciones de contenedor.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.
tags	object	Etiquetas del recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

JobConfiguration

Propiedades de configuración del trabajo de Aplicaciones de contenedor no con versiones

Nombre	Tipo	Valor predeterminado	Description
eventTriggerConfig	EventTriggerConfig		Desencadene la configuración de un trabajo controlado por eventos.
manualTriggerConfig	ManualTriggerConfig		Configuración manual del desencadenador para un único trabajo de ejecución. Las propiedades replicaCompletionCount y paralelismo se establecerían en 1 de forma predeterminada.
registries	RegistryCredentials[]		Recopilación de credenciales de registro de contenedor privadas usadas por un trabajo de aplicaciones contenedoras
replicaRetryLimit	integer		Número máximo de reintentos antes de que se produzca un error en el trabajo.
replicaTimeout	integer		Número máximo de segundos que se puede ejecutar una réplica.
scheduleTriggerConfig	ScheduleTriggerConfig		Programación de desencadenador de repetición con formato Cron ("* * * * * *") para cronjobs. Las finalizaciones de propiedades y el paralelismo se establecerían en 1 de forma predeterminada.
secrets	Secret[]		Recopilación de secretos usados por un trabajo de Container Apps
triggerType	TriggerType	Manual	Tipo de desencadenador del trabajo

JobProvisioningState

Estado de aprovisionamiento del trabajo de aplicaciones de contenedor.

Nombre	Tipo	Description
Canceled	string
Deleting	string
Failed	string
InProgress	string
Succeeded	string

JobScale

Escalado de configuraciones para trabajos controlados por eventos.

Nombre	Tipo	Valor predeterminado	Description
maxExecutions	integer	100	Número máximo de ejecuciones de trabajos que se crean para un desencadenador, el valor predeterminado es 100.
minExecutions	integer	0	Número mínimo de ejecuciones de trabajos que se crean para un desencadenador, el valor predeterminado es 0.
pollingInterval	integer		Intervalo para comprobar cada origen de eventos en segundos. El valor predeterminado es 30s
rules	JobScaleRule[]		Reglas de escalado.

JobScaleRule

Regla de escalado.

Nombre	Tipo	Description
auth	ScaleRuleAuth[]	Secretos de autenticación para la regla de escalado.
metadata	object	Propiedades de metadatos para describir la regla de escalado.
name	string	Nombre de la regla de escalado
type	string	Tipo de la regla de escalado, por ejemplo: azure-servicebus, redis, etc.

JobTemplate

Definición de aplicación con versiones del trabajo de Container Apps. Define el estado deseado de una revisión inmutable. Los cambios realizados en esta sección darán lugar a que se cree una nueva revisión.

Nombre	Tipo	Description
containers	Container[]	Lista de definiciones de contenedor para la aplicación contenedora.
initContainers	InitContainer[]	Lista de contenedores especializados que se ejecutan antes de los contenedores de aplicaciones.
volumes	Volume[]	Lista de definiciones de volumen para la aplicación contenedora.

ManagedServiceIdentity

Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario)

Nombre	Tipo	Description
principalId	string	Identificador de la entidad de servicio de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
tenantId	string	Identificador de inquilino de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
type	ManagedServiceIdentityType	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).
userAssignedIdentities	<string, UserAssignedIdentity>	identidades de User-Assigned Conjunto de identidades asignadas por el usuario asociadas al recurso. Las claves del diccionario userAssignedIdentities serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Los valores del diccionario pueden ser objetos vacíos ({}) en las solicitudes.

ManagedServiceIdentityType

Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).

Nombre	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

ManualTriggerConfig

Configuración manual del desencadenador para un único trabajo de ejecución. Las propiedades replicaCompletionCount y paralelismo se establecerían en 1 de forma predeterminada.

Nombre	Tipo	Description
parallelism	integer	Número de réplicas paralelas de un trabajo que se puede ejecutar en un momento dado.
replicaCompletionCount	integer	Número mínimo de finalizaciones de réplica correctas antes de la finalización general del trabajo.

RegistryCredentials

Registro privado de la aplicación contenedora

Nombre	Tipo	Description
identity	string	Una identidad administrada que se va a usar para autenticarse con Azure Container Registry. En el caso de las identidades asignadas por el usuario, use el identificador de recurso de identidad asignado por el usuario completo. En el caso de las identidades asignadas por el sistema, use "system"
passwordSecretRef	string	Nombre del secreto que contiene la contraseña de inicio de sesión del Registro.
server	string	Servidor de Container Registry
username	string	Nombre de usuario de Container Registry

ScaleRuleAuth

Secretos de autenticación para la regla de escalado

Nombre	Tipo	Description
secretRef	string	Nombre del secreto desde el que se van a extraer los parámetros de autenticación.
triggerParameter	string	Parámetro de desencadenador que usa el secreto

ScheduleTriggerConfig

Programación de desencadenador de repetición con formato Cron ("* * * * * *") para cronjobs. Las finalizaciones de propiedades y el paralelismo se establecerían en 1 de forma predeterminada.

Nombre	Tipo	Description
cronExpression	string	Cron formateado programación de repetición ("* * * *") de un trabajo cron.
parallelism	integer	Número de réplicas paralelas de un trabajo que se puede ejecutar en un momento dado.
replicaCompletionCount	integer	Número mínimo de finalizaciones de réplica correctas antes de la finalización general del trabajo.

Scheme

Esquema que se va a usar para conectarse al host. El valor predeterminado es HTTP.

Nombre	Tipo	Description
HTTP	string
HTTPS	string

Secret

Definición de secreto.

Nombre	Tipo	Description
identity	string	Identificador de recurso de una identidad administrada para autenticarse con Azure Key Vault o sistema para usar una identidad asignada por el sistema.
keyVaultUrl	string	Dirección URL de Azure Key Vault que apunta al secreto al que hace referencia la aplicación contenedora.
name	string	Nombre del secreto.
value	string	Valor secreto.

SecretVolumeItem

Secreto que se va a agregar al volumen.

Nombre	Tipo	Description
path	string	Ruta de acceso al secreto del proyecto al que. Si no se proporciona ninguna ruta de acceso, la ruta de acceso tiene como valor predeterminado el nombre del secreto enumerado en secretRef.
secretRef	string	Nombre del secreto de la aplicación contenedora desde el que se va a extraer el valor del secreto.

StorageType

Tipo de almacenamiento para el volumen. Si no se proporciona, use EmptyDir.

Nombre	Tipo	Description
AzureFile	string
EmptyDir	string
Secret	string

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

TcpSocket

TCPSocket especifica una acción que implica un puerto TCP. Todavía no se admiten enlaces TCP.

Nombre	Tipo	Description
host	string	Opcional: el nombre de host al que conectarse, tiene como valor predeterminado la dirección IP del pod.
port	integer	Número o nombre del puerto al que se va a acceder en el contenedor. El número debe estar en el intervalo de 1 a 65535. El nombre debe ser un IANA_SVC_NAME.

TriggerType

Tipo de desencadenador del trabajo

Nombre	Tipo	Description
Event	string
Manual	string
Schedule	string

Type

Tipo de sondeo.

Nombre	Tipo	Description
Liveness	string
Readiness	string
Startup	string

UserAssignedIdentity

Propiedades de identidad asignadas por el usuario

Nombre	Tipo	Description
clientId	string	Identificador de cliente de la identidad asignada.
principalId	string	Identificador de entidad de seguridad de la identidad asignada.

Volume

Definiciones de volumen para la aplicación contenedora.

Nombre	Tipo	Description
mountOptions	string	Opciones de montaje usadas durante el montaje de AzureFile. Debe ser una cadena separada por comas.
name	string	Nombre del volumen.
secrets	SecretVolumeItem[]	Lista de secretos que se van a agregar en el volumen. Si no se proporcionan secretos, todos los secretos de la colección se agregarán al volumen.
storageName	string	Nombre del recurso de almacenamiento. No es necesario proporcionar emptyDir y secret.
storageType	StorageType	Tipo de almacenamiento para el volumen. Si no se proporciona, use EmptyDir.

VolumeMount

Montaje de volumen para la aplicación contenedora.

Nombre	Tipo	Description
mountPath	string	Ruta de acceso dentro del contenedor en el que se debe montar el volumen. No debe contener ':'.
subPath	string	Ruta de acceso dentro del volumen desde el que se debe montar el volumen del contenedor. El valor predeterminado es "" (raíz del volumen).
volumeName	string	Debe coincidir con el nombre de un volumen.

Share via