PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/?api-version=2023-08-01-preview

Job Name

The ID of the target subscription. The value must be an UUID.

The name of the resource group. The name is case insensitive.

Default value: "application/json"

The complex type of the extended location.

The name of the extended location.

The type of extendedLocation.

Possible values:

• "CustomLocation"

The geo-location where the resource lives

Container Apps Job resource specific properties.

Container Apps Job versioned application definition. Defines the desired state of an immutable revision. Any changes to this section Will result in a new revision being created

List of specialized containers that run before app containers.

Container volume mounts.

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

This must match the Name of a Volume.

Path within the container at which the volume should be mounted.Must not contain ':'.

Custom container name.

Container environment variables.

Environment variable name.

Name of the Container App secret from which to pull the environment variable value.

Non-secret environment variable value.

Container start command.

Container App container resource requirements.

Required memory, e.g. "250Mb"

Required CPU in cores, e.g. 0.5

Ephemeral Storage, e.g. "1Gi"

Container image tag.

Container start command arguments.

List of container definitions for the Container App.

List of probes for the container.

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10.

HTTPGet specifies the http request to perform.

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

Custom headers to set in the request. HTTP allows repeated headers.

The header field name

The header field value

Scheme to use for connecting to the host. Defaults to HTTP.

Possible values:

• "HTTP"
• "HTTPS"

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

Path to access on the HTTP server.

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

Optional: Host name to connect to, defaults to the pod IP.

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour)

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.

Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.

The type of probe.

Possible values:

• "Startup"
• "Readiness"
• "Liveness"

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10.

Container volume mounts.

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

This must match the Name of a Volume.

Path within the container at which the volume should be mounted.Must not contain ':'.

Custom container name.

Container environment variables.

Environment variable name.

Name of the Container App secret from which to pull the environment variable value.

Non-secret environment variable value.

Container start command.

Container App container resource requirements.

Required memory, e.g. "250Mb"

Required CPU in cores, e.g. 0.5

Ephemeral Storage, e.g. "1Gi"

Container image tag.

Container start command arguments.

List of volume definitions for the Container App.

Name of storage resource. No need to provide for EmptyDir and Secret.

Volume name.

Storage type for the volume. If not provided, use EmptyDir.

Possible values:

• "EmptyDir"
• "AzureFile"
• "Secret"

List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume.

Name of the Container App secret from which to pull the secret value.

Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef.

Mount options used while mounting the AzureFile. Must be a comma-separated string.

Provisioning state of the Container Apps Job.

Possible values:

• "Succeeded"
• "Deleting"
• "Canceled"
• "InProgress"
• "Failed"

Workload profile name for container apps to execute on.

Non versioned Container Apps Job configuration properties

Collection of private container registry credentials used by a Container apps job

The name of the Secret that contains the registry login password

Container Registry Username

Container Registry Server

A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use 'system'

Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default

Minimum number of successful replica completions before overall job completion.

Number of parallel replicas of a job that can run at a given time.

Collection of secrets used by a Container Apps Job

Secret Name.

Azure Key Vault URL pointing to the secret referenced by the container app.

Secret Value.

Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.

Maximum number of seconds a replica is allowed to run.

Maximum number of retries before failing the job.

Trigger type of the job

Possible values:

• "Schedule"
• "Manual"
• "Event"

Default value: "Manual"

Cron formatted repeating trigger schedule ("* * * * *") for cronjobs. Properties completions and parallelism would be set to 1 by default

Minimum number of successful replica completions before overall job completion.

Number of parallel replicas of a job that can run at a given time.

Cron formatted repeating schedule ("* * * * *") of a Cron Job.

Trigger configuration of an event driven job.

Minimum number of successful replica completions before overall job completion.

Number of parallel replicas of a job that can run at a given time.

Scaling configurations for event driven jobs.

Scaling rules.

Authentication secrets for the scale rule.

Trigger Parameter that uses the secret

Name of the secret from which to pull the auth params.

Scale Rule Name

Type of the scale rule eg: azure-servicebus, redis etc.

Metadata properties to describe the scale rule.

Maximum number of job executions that are created for a trigger, default 100.

Default value: 100

Minimum number of job executions that are created for a trigger, default 0

Default value: 0

Interval to check each event source in seconds. Defaults to 30s

Outbound IP Addresses of a container apps job.

Resource ID of environment.

The endpoint of the eventstream of the container apps job.

Resource tags.

Managed service identity (system assigned and/or user assigned identities)

The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Possible values:

• "SystemAssigned"
• "SystemAssigned,UserAssigned"
• "UserAssigned"
• "None"

The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.