az containerapp job

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Commands to manage Container Apps jobs.

Commands

Name	Description	Type	Status
az containerapp job create	Create a container apps job.	Core	GA
az containerapp job create (containerapp extension)	Create a container apps job.	Extension	GA
az containerapp job delete	Delete a Container Apps Job.	Core	GA
az containerapp job delete (containerapp extension)	Delete a Container Apps Job.	Extension	GA
az containerapp job execution	Commands to view executions of a Container App Job.	Core	GA
az containerapp job execution list	Get list of all executions of a Container App Job.	Core	GA
az containerapp job execution show	Get execution of a Container App Job.	Core	GA
az containerapp job identity	Commands to manage managed identities for container app job.	Core	GA
az containerapp job identity assign	Assign managed identity to a container app job.	Core	GA
az containerapp job identity remove	Remove a managed identity from a container app job.	Core	GA
az containerapp job identity show	Show managed identities of a container app job.	Core	GA
az containerapp job list	List Container Apps Job by subscription or resource group.	Core	GA
az containerapp job list (containerapp extension)	List Container Apps Job by subscription or resource group.	Extension	GA
az containerapp job logs	Show container app job logs.	Extension	Preview
az containerapp job logs show	Show past logs and/or print logs in real time (with the --follow parameter). Note that the logs are only taken from one execution, replica, and container.	Extension	Preview
az containerapp job registry	Commands to manage container registry information of a Container App Job.	Core and Extension	Preview
az containerapp job registry list	List container registries configured in a Container App Job.	Core	Preview
az containerapp job registry remove	Remove a container registry's details in a Container App Job.	Core	Preview
az containerapp job registry set	Add or update a container registry's details in a Container App Job.	Core	Preview
az containerapp job registry set (containerapp extension)	Add or update a container registry's details in a Container App Job.	Extension	Preview
az containerapp job registry show	Show details of a container registry from a Container App Job.	Core	Preview
az containerapp job replica	Manage container app replicas.	Extension	Preview
az containerapp job replica list	List a container app job execution's replica.	Extension	Preview
az containerapp job secret	Commands to manage secrets.	Core	GA
az containerapp job secret list	List the secrets of a container app job.	Core	GA
az containerapp job secret remove	Remove secrets from a container app job.	Core	GA
az containerapp job secret set	Create/update secrets.	Core	GA
az containerapp job secret show	Show details of a secret.	Core	GA
az containerapp job show	Show details of a Container Apps Job.	Core	GA
az containerapp job show (containerapp extension)	Show details of a Container Apps Job.	Extension	GA
az containerapp job start	Start a Container Apps Job execution.	Core	GA
az containerapp job stop	Stops a Container Apps Job execution.	Core	GA
az containerapp job update	Update a Container Apps Job.	Core	GA
az containerapp job update (containerapp extension)	Update a Container Apps Job.	Extension	GA

az containerapp job create

Create a container apps job.

az containerapp job create --name
                           --resource-group
                           [--args]
                           [--command]
                           [--container-name]
                           [--cpu]
                           [--cron-expression]
                           [--env-vars]
                           [--environment]
                           [--image]
                           [--max-executions]
                           [--memory]
                           [--mi-system-assigned]
                           [--mi-user-assigned]
                           [--min-executions]
                           [--no-wait]
                           [--parallelism]
                           [--polling-interval]
                           [--rcc --replica-completion-count]
                           [--registry-identity]
                           [--registry-password]
                           [--registry-server]
                           [--registry-username]
                           [--replica-retry-limit]
                           [--replica-timeout]
                           [--scale-rule-auth --sra]
                           [--scale-rule-metadata --srm]
                           [--scale-rule-name --srn]
                           [--scale-rule-type --srt]
                           [--secrets]
                           [--tags]
                           [--trigger-type]
                           [--workload-profile-name]
                           [--yaml]

Examples

Create a container apps job with Trigger Type as Manual.

az containerapp job create -n MyContainerappsjob -g MyResourceGroup \
    --environment MyContainerappEnv \
    --trigger-type Manual \
    --replica-timeout 5 \
    --replica-retry-limit 2 \
    --replica-completion-count 1 \
    --parallelism 1 \
    --image imageName \
    --workload-profile-name my-wlp

Create a container apps job with Trigger Type as Schedule.

az containerapp job create -n MyContainerappsjob -g MyResourceGroup \
    --environment MyContainerappEnv \
    --trigger-type Schedule \
    --replica-timeout 5 \
    --replica-retry-limit 2 \
    --replica-completion-count 1 \
    --parallelism 1 \
    --cron-expression "*/1 * * * *" \
    --image imageName

Create a container apps job with Trigger Type as Event.

az containerapp job create -n MyContainerappsjob -g MyResourceGroup \
    --environment MyContainerappEnv \
    --trigger-type Event \
    --replica-timeout 5 \
    --replica-retry-limit 2 \
    --replica-completion-count 1 \
    --parallelism 1 \
    --polling-interval 30 \
    --min-executions 0 \
    --max-executions 1 \
    --scale-rule-name queue \
    --scale-rule-type azure-queue \
    --scale-rule-metadata "accountName=mystorageaccountname" \
                          "cloud=AzurePublicCloud" \
                          "queueLength=5" "queueName=foo" \
    --scale-rule-auth "connection=my-connection-string-secret-name" \
    --image imageName

Required Parameters

--name -n

The name of the Container Apps Job. A name must consist of lower case alphanumeric characters or '-', start with a letter, end with an alphanumeric character, cannot have '--', and must be less than 32 characters.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--args

A list of container startup command argument(s). Space-separated values e.g. "-c" "mycommand". Empty string to clear existing values.

Property	Value
Parameter group:	Container Arguments

--command

A list of supported commands on the container that will executed during startup. Space-separated values e.g. "/bin/queue" "mycommand". Empty string to clear existing values.

Property	Value
Parameter group:	Container Arguments

--container-name

Name of the container.

Property	Value
Parameter group:	Container Arguments

--cpu

Required CPU in cores from 0.25 - 2.0, e.g. 0.5.

Property	Value
Parameter group:	Container Arguments

--cron-expression

Cron expression. Only supported for trigger type "Schedule".

--env-vars

A list of environment variable(s) for the container. Space-separated values in 'key=value' format. Empty string to clear existing values. Prefix value with 'secretref:' to reference a secret.

Property	Value
Parameter group:	Container Arguments

--environment

Name or resource ID of the container app's environment.

--image

Container image, e.g. publisher/image-name:tag.

--max-executions

Maximum number of job executions to run per polling interval.

Property	Value
Parameter group:	Scale Arguments

--memory

Required memory from 0.5 - 4.0 ending with "Gi", e.g. 1.0Gi.

Property	Value
Parameter group:	Container Arguments

--mi-system-assigned

Boolean indicating whether to assign system-assigned identity.

Property	Value
Default value:	False

--mi-user-assigned

Space-separated user identities to be assigned.

--min-executions

Minimum number of job executions to run per polling interval.

Property	Value
Parameter group:	Scale Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--parallelism

Maximum number of replicas to run per execution.

--polling-interval

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

Property	Value
Parameter group:	Scale Arguments

--rcc --replica-completion-count

Number of replicas that need to complete successfully for execution to succeed.

--registry-identity

A Managed Identity to authenticate with the registry server instead of username/password. Use a resource ID or 'system' for user-defined and system-defined identities, respectively. The registry must be an ACR. If possible, an 'acrpull' role assignemnt will be created for the identity automatically.

Property	Value
Parameter group:	Configuration Arguments

--registry-password

The password to log in to container registry. If stored as a secret, value must start with 'secretref:' followed by the secret name.

Property	Value
Parameter group:	Configuration Arguments

--registry-server

The container registry server hostname, e.g. myregistry.azurecr.io.

Property	Value
Parameter group:	Configuration Arguments

--registry-username

The username to log in to container registry.

Property	Value
Parameter group:	Configuration Arguments

--replica-retry-limit

Maximum number of retries before the replica fails.

--replica-timeout

Maximum number of seconds a replica can execute.

--scale-rule-auth --sra

Scale rule auth parameters. Auth parameters must be in format "{triggerParameter}={secretRef} {triggerParameter}={secretRef} ...".

Property	Value
Parameter group:	Scale Arguments

--scale-rule-metadata --srm

Scale rule metadata. Metadata must be in format "{key}={value} {key}={value} ...".

Property	Value
Parameter group:	Scale Arguments

--scale-rule-name --srn

The name of the scale rule.

Property	Value
Parameter group:	Scale Arguments

--scale-rule-type --srt

The type of the scale rule.

Property	Value
Parameter group:	Scale Arguments

--secrets -s

A list of secret(s) for the container app. Space-separated values in 'key=value' format.

Property	Value
Parameter group:	Configuration Arguments

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--trigger-type

Trigger type. Schedule | Event | Manual.

--workload-profile-name -w

The friendly name for the workload profile.

--yaml

Path to a .yaml file with the configuration of a container app. All other parameters will be ignored. For an example, see https://learn.microsoft.com/azure/container-apps/azure-resource-manager-api-spec#examples.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az containerapp job create (containerapp extension)

Create a container apps job.

az containerapp job create --name
                           --resource-group
                           [--args]
                           [--command]
                           [--container-name]
                           [--cpu]
                           [--cron-expression]
                           [--env-vars]
                           [--environment]
                           [--environment-type {connected, managed}]
                           [--image]
                           [--max-executions]
                           [--memory]
                           [--mi-system-assigned]
                           [--mi-user-assigned]
                           [--min-executions]
                           [--no-wait]
                           [--parallelism]
                           [--polling-interval]
                           [--rcc --replica-completion-count]
                           [--registry-identity]
                           [--registry-password]
                           [--registry-server]
                           [--registry-username]
                           [--replica-retry-limit]
                           [--replica-timeout]
                           [--scale-rule-auth --sra]
                           [--scale-rule-identity --sri]
                           [--scale-rule-metadata --srm]
                           [--scale-rule-name --srn]
                           [--scale-rule-type --srt]
                           [--secrets]
                           [--tags]
                           [--trigger-type]
                           [--workload-profile-name]
                           [--yaml]

Examples

Create a container apps job with Trigger Type as Manual.

az containerapp job create -n MyContainerappsjob -g MyResourceGroup \
    --environment MyContainerappEnv \
    --trigger-type Manual \
    --replica-timeout 5 \
    --replica-retry-limit 2 \
    --replica-completion-count 1 \
    --parallelism 1 \
    --image imageName \
    --workload-profile-name my-wlp

Create a container apps job with Trigger Type as Schedule.

az containerapp job create -n MyContainerappsjob -g MyResourceGroup \
    --environment MyContainerappEnv \
    --trigger-type Schedule \
    --replica-timeout 5 \
    --replica-retry-limit 2 \
    --replica-completion-count 1 \
    --parallelism 1 \
    --cron-expression "*/1 * * * *" \
    --image imageName

Create a container apps job with Trigger Type as Event.

az containerapp job create -n MyContainerappsjob -g MyResourceGroup \
    --environment MyContainerappEnv \
    --trigger-type Event \
    --replica-timeout 5 \
    --replica-retry-limit 2 \
    --replica-completion-count 1 \
    --parallelism 1 \
    --polling-interval 30 \
    --min-executions 0 \
    --max-executions 1 \
    --scale-rule-name queueJob \
    --scale-rule-type azure-queue \
    --scale-rule-metadata "accountName=mystorageaccountname" \
                          "cloud=AzurePublicCloud" \
                          "queueLength=5" "queueName=foo" \
    --scale-rule-auth "connection=my-connection-string-secret-name" \
    --image imageName

Create container app job with Trigger Type as Event using identity to authenticate

az containerapp job create -n MyContainerappsjob -g MyResourceGroup \
    --environment MyContainerappEnv
    --trigger-type Event \
    --replica-timeout 5 \
    --replica-retry-limit 2 \
    --replica-completion-count 1 \
    --parallelism 1 \
    --polling-interval 30 \
    --min-executions 0 \
    --max-executions 1 \
    --scale-rule-name azure-queue \
    --scale-rule-type azure-queue \
    --scale-rule-metadata "accountName=mystorageaccountname" \
                          "cloud=AzurePublicCloud" \
                          "queueLength=5" "queueName=foo" \
    --scale-rule-identity myUserIdentityResourceId \
    --image imageName

Create a container apps job hosted on a Connected Environment.

az containerapp job create -n MyContainerappsjob -g MyResourceGroup \
    --environment MyContainerappConnectedEnv
    --environment-type connected
    --trigger-type Manual \
    --replica-timeout 5 \
    --replica-retry-limit 2 \
    --replica-completion-count 1 \
    --parallelism 1 \
    --image imageName \
    --workload-profile-name my-wlp

Required Parameters

--name -n

The name of the Container Apps Job. A name must consist of lower case alphanumeric characters or '-', start with a letter, end with an alphanumeric character, cannot have '--', and must be less than 32 characters.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--args

A list of container startup command argument(s). Space-separated values e.g. "-c" "mycommand". Empty string to clear existing values.

Property	Value
Parameter group:	Container Arguments

--command

A list of supported commands on the container that will executed during startup. Space-separated values e.g. "/bin/queue" "mycommand". Empty string to clear existing values.

Property	Value
Parameter group:	Container Arguments

--container-name

Name of the container.

Property	Value
Parameter group:	Container Arguments

--cpu

Required CPU in cores from 0.25 - 2.0, e.g. 0.5.

Property	Value
Parameter group:	Container Arguments

--cron-expression

Cron expression. Only supported for trigger type "Schedule".

--env-vars

A list of environment variable(s) for the container. Space-separated values in 'key=value' format. Empty string to clear existing values. Prefix value with 'secretref:' to reference a secret.

Property	Value
Parameter group:	Container Arguments

--environment

Name or resource ID of the container app's environment.

--environment-type

Preview

Type of environment.

Property	Value
Default value:	managed
Accepted values:	connected, managed

--image

Container image, e.g. publisher/image-name:tag.

--max-executions

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

Property	Value
Parameter group:	Scale Arguments
Default value:	100

--memory

Required memory from 0.5 - 4.0 ending with "Gi", e.g. 1.0Gi.

Property	Value
Parameter group:	Container Arguments

--mi-system-assigned

Boolean indicating whether to assign system-assigned identity.

Property	Value
Default value:	False

--mi-user-assigned

Space-separated user identities to be assigned.

--min-executions

Minimum number of job executions that are created for a trigger. Default: 0.

Property	Value
Parameter group:	Scale Arguments
Default value:	0

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--parallelism

Maximum number of replicas to run per execution.

Property	Value
Default value:	1

--polling-interval

Interval to check each event source in seconds.

Property	Value
Parameter group:	Scale Arguments
Default value:	30

--rcc --replica-completion-count

Number of replicas that need to complete successfully for execution to succeed.

Property	Value
Default value:	1

--registry-identity

The managed identity with which to authenticate to the Azure Container Registry (instead of username/password). Use 'system' for a system-defined identity, Use 'system-environment' for an environment level system-defined identity or a resource id for a user-defined environment/containerappjob level identity. The managed identity should have been assigned acrpull permissions on the ACR before deployment (use 'az role assignment create --role acrpull ...').

Property	Value
Parameter group:	Configuration Arguments

--registry-password

The password to log in to container registry. If stored as a secret, value must start with 'secretref:' followed by the secret name.

Property	Value
Parameter group:	Configuration Arguments

--registry-server

The container registry server hostname, e.g. myregistry.azurecr.io.

Property	Value
Parameter group:	Configuration Arguments

--registry-username

The username to log in to container registry.

Property	Value
Parameter group:	Configuration Arguments

--replica-retry-limit

Maximum number of retries before the replica fails. Default: 0.

Property	Value
Default value:	0

--replica-timeout

Maximum number of seconds a replica can execute.

Property	Value
Default value:	1800

--scale-rule-auth --sra

Scale rule auth parameters. Auth parameters must be in format "{triggerParameter}={secretRef} {triggerParameter}={secretRef} ...".

Property	Value
Parameter group:	Scale Arguments

--scale-rule-identity --sri

Preview

Resource ID of a managed identity to authenticate with Azure scaler resource(storage account/eventhub or else), or System to use a system-assigned identity.

Property	Value
Parameter group:	Scale Arguments

--scale-rule-metadata --srm

Scale rule metadata. Metadata must be in format "{key}={value} {key}={value} ...".

Property	Value
Parameter group:	Scale Arguments

--scale-rule-name --srn

The name of the scale rule.

Property	Value
Parameter group:	Scale Arguments

--scale-rule-type --srt

The type of the scale rule.

Property	Value
Parameter group:	Scale Arguments

--secrets -s

A list of secret(s) for the container app. Space-separated values in 'key=value' format.

Property	Value
Parameter group:	Configuration Arguments

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--trigger-type

Trigger type. Schedule | Event | Manual.

--workload-profile-name -w

The friendly name for the workload profile.

--yaml

Path to a .yaml file with the configuration of a container app. All other parameters will be ignored. For an example, see https://learn.microsoft.com/azure/container-apps/azure-resource-manager-api-spec#examples.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az containerapp job delete

Delete a Container Apps Job.

az containerapp job delete [--ids]
                           [--name]
                           [--no-wait]
                           [--resource-group]
                           [--subscription]
                           [--yes]

Examples

Delete a job.

az containerapp job delete -n my-containerapp-job -g MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The name of the Container Apps Job. A name must consist of lower case alphanumeric characters or '-', start with a letter, end with an alphanumeric character, cannot have '--', and must be less than 32 characters.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az containerapp job delete (containerapp extension)

Delete a Container Apps Job.

az containerapp job delete [--ids]
                           [--name]
                           [--no-wait]
                           [--resource-group]
                           [--subscription]
                           [--yes]

Examples

Delete a job.

az containerapp job delete -n my-containerapp-job -g MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The name of the Container Apps Job. A name must consist of lower case alphanumeric characters or '-', start with a letter, end with an alphanumeric character, cannot have '--', and must be less than 32 characters.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az containerapp job list

List Container Apps Job by subscription or resource group.

az containerapp job list [--resource-group]

Examples

List jobs in the current subscription.

az containerapp job list

List environments by resource group.

az containerapp job list -g MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az containerapp job list (containerapp extension)

List Container Apps Job by subscription or resource group.

az containerapp job list [--resource-group]

Examples

List jobs in the current subscription.

az containerapp job list

List environments by resource group.

az containerapp job list -g MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az containerapp job show

Show details of a Container Apps Job.

az containerapp job show [--ids]
                         [--name]
                         [--resource-group]
                         [--subscription]

Examples

Show the details of a job.

az containerapp job show -n my-containerapp-job -g MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The name of the Container Apps Job. A name must consist of lower case alphanumeric characters or '-', start with a letter, end with an alphanumeric character, cannot have '--', and must be less than 32 characters.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az containerapp job show (containerapp extension)

Show details of a Container Apps Job.

az containerapp job show [--ids]
                         [--name]
                         [--resource-group]
                         [--subscription]

Examples

Show the details of a job.

az containerapp job show -n my-containerapp-job -g MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The name of the Container Apps Job. A name must consist of lower case alphanumeric characters or '-', start with a letter, end with an alphanumeric character, cannot have '--', and must be less than 32 characters.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az containerapp job start

Start a Container Apps Job execution.

az containerapp job start [--args]
                          [--command]
                          [--container-name]
                          [--cpu]
                          [--env-vars]
                          [--ids]
                          [--image]
                          [--memory]
                          [--name]
                          [--no-wait]
                          [--registry-identity]
                          [--resource-group]
                          [--subscription]
                          [--yaml]

Examples

Start a job execution.

az containerapp job start -n my-containerapp-job -g MyResourceGroup

Start a job with different image and configurations.

az containerapp job start -n my-containerapp-job -g MyResourceGroup --image MyImageName --cpu 0.5 --memory 1.0Gi

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--args

A list of container startup command argument(s). Space-separated values e.g. "-c" "mycommand". Empty string to clear existing values.

Property	Value
Parameter group:	Container Arguments

--command

A list of supported commands on the container that will executed during startup. Space-separated values e.g. "/bin/queue" "mycommand". Empty string to clear existing values.

Property	Value
Parameter group:	Container Arguments

--container-name

Name of the container.

Property	Value
Parameter group:	Container Arguments

--cpu

Required CPU in cores from 0.25 - 2.0, e.g. 0.5.

Property	Value
Parameter group:	Container Arguments

--env-vars

A list of environment variable(s) for the container. Space-separated values in 'key=value' format. Empty string to clear existing values. Prefix value with 'secretref:' to reference a secret.

Property	Value
Parameter group:	Container Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--image

Container image, e.g. publisher/image-name:tag.

--memory

Required memory from 0.5 - 4.0 ending with "Gi", e.g. 1.0Gi.

Property	Value
Parameter group:	Container Arguments

--name -n

The name of the Container Apps Job. A name must consist of lower case alphanumeric characters or '-', start with a letter, end with an alphanumeric character, cannot have '--', and must be less than 32 characters.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--registry-identity

A Managed Identity to authenticate with the registry server instead of username/password. Use a resource ID or 'system' for user-defined and system-defined identities, respectively. The registry must be an ACR. If possible, an 'acrpull' role assignemnt will be created for the identity automatically.

Property	Value
Parameter group:	Configuration Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--yaml

Path to a .yaml file with the configuration of a container app. All other parameters will be ignored. For an example, see https://learn.microsoft.com/azure/container-apps/azure-resource-manager-api-spec#examples.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az containerapp job stop

Stops a Container Apps Job execution.

az containerapp job stop [--ids]
                         [--job-execution-name]
                         [--name]
                         [--no-wait]
                         [--resource-group]
                         [--subscription]

Examples

Stop a job execution.

az containerapp job stop -n my-containerapp-job -g MyResourceGroup

Stop a job execution giving a specific job execution name.

az containerapp job stop -n my-containerapp-job -g MyResourceGroup --job-execution-name MyContainerAppJob-66v9xh0

Stop all running job executions.

az containerapp job stop -n my-containerapp-job -g MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--job-execution-name

Name of the specific job execution which needs to be stopped.

--name -n

The name of the Container Apps Job. A name must consist of lower case alphanumeric characters or '-', start with a letter, end with an alphanumeric character, cannot have '--', and must be less than 32 characters.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az containerapp job update

Update a Container Apps Job.

az containerapp job update [--args]
                           [--command]
                           [--container-name]
                           [--cpu]
                           [--cron-expression]
                           [--ids]
                           [--image]
                           [--max-executions]
                           [--memory]
                           [--min-executions]
                           [--name]
                           [--no-wait]
                           [--parallelism]
                           [--polling-interval]
                           [--rcc --replica-completion-count]
                           [--remove-all-env-vars]
                           [--remove-env-vars]
                           [--replace-env-vars]
                           [--replica-retry-limit]
                           [--replica-timeout]
                           [--resource-group]
                           [--scale-rule-auth --sra]
                           [--scale-rule-metadata --srm]
                           [--scale-rule-name --srn]
                           [--scale-rule-type --srt]
                           [--set-env-vars]
                           [--subscription]
                           [--tags]
                           [--workload-profile-name]
                           [--yaml]

Examples

Update a job's replica timeout.

az containerapp job update -n my-containerapp-job -g MyResourceGroup \
    --replica-timeout 10

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--args

A list of container startup command argument(s). Space-separated values e.g. "-c" "mycommand". Empty string to clear existing values.

Property	Value
Parameter group:	Container Arguments

--command

A list of supported commands on the container that will executed during startup. Space-separated values e.g. "/bin/queue" "mycommand". Empty string to clear existing values.

Property	Value
Parameter group:	Container Arguments

--container-name

Name of the container.

Property	Value
Parameter group:	Container Arguments

--cpu

Required CPU in cores from 0.25 - 2.0, e.g. 0.5.

Property	Value
Parameter group:	Container Arguments

--cron-expression

Cron expression. Only supported for trigger type "Schedule".

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--image

Container image, e.g. publisher/image-name:tag.

--max-executions

Maximum number of job executions to run per polling interval.

Property	Value
Parameter group:	Scale Arguments

--memory

Required memory from 0.5 - 4.0 ending with "Gi", e.g. 1.0Gi.

Property	Value
Parameter group:	Container Arguments

--min-executions

Minimum number of job executions to run per polling interval.

Property	Value
Parameter group:	Scale Arguments

--name -n

The name of the Container Apps Job. A name must consist of lower case alphanumeric characters or '-', start with a letter, end with an alphanumeric character, cannot have '--', and must be less than 32 characters.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--parallelism

Maximum number of replicas to run per execution.

--polling-interval

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

Property	Value
Parameter group:	Scale Arguments

--rcc --replica-completion-count

Number of replicas that need to complete successfully for execution to succeed.

--remove-all-env-vars

Remove all environment variable(s) from container..

Property	Value
Parameter group:	Environment variables Arguments
Default value:	False

--remove-env-vars

Remove environment variable(s) from container. Space-separated environment variable names.

Property	Value
Parameter group:	Environment variables Arguments

--replace-env-vars

Replace environment variable(s) in container. Other existing environment variables are removed. Space-separated values in 'key=value' format. If stored as a secret, value must start with 'secretref:' followed by the secret name.

Property	Value
Parameter group:	Environment variables Arguments

--replica-retry-limit

Maximum number of retries before the replica fails.

--replica-timeout

Maximum number of seconds a replica can execute.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--scale-rule-auth --sra

Scale rule auth parameters. Auth parameters must be in format "{triggerParameter}={secretRef} {triggerParameter}={secretRef} ...".

Property	Value
Parameter group:	Scale Arguments

--scale-rule-metadata --srm

Scale rule metadata. Metadata must be in format "{key}={value} {key}={value} ...".

Property	Value
Parameter group:	Scale Arguments

--scale-rule-name --srn

The name of the scale rule.

Property	Value
Parameter group:	Scale Arguments

--scale-rule-type --srt

The type of the scale rule.

Property	Value
Parameter group:	Scale Arguments

--set-env-vars

Add or update environment variable(s) in container. Existing environment variables are not modified. Space-separated values in 'key=value' format. If stored as a secret, value must start with 'secretref:' followed by the secret name.

Property	Value
Parameter group:	Environment variables Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--workload-profile-name -w

The friendly name for the workload profile.

--yaml

Path to a .yaml file with the configuration of a container app. All other parameters will be ignored. For an example, see https://learn.microsoft.com/azure/container-apps/azure-resource-manager-api-spec#examples.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az containerapp job update (containerapp extension)

Update a Container Apps Job.

az containerapp job update [--args]
                           [--command]
                           [--container-name]
                           [--cpu]
                           [--cron-expression]
                           [--ids]
                           [--image]
                           [--max-executions]
                           [--memory]
                           [--min-executions]
                           [--name]
                           [--no-wait]
                           [--parallelism]
                           [--polling-interval]
                           [--rcc --replica-completion-count]
                           [--remove-all-env-vars]
                           [--remove-env-vars]
                           [--replace-env-vars]
                           [--replica-retry-limit]
                           [--replica-timeout]
                           [--resource-group]
                           [--scale-rule-auth --sra]
                           [--scale-rule-identity --sri]
                           [--scale-rule-metadata --srm]
                           [--scale-rule-name --srn]
                           [--scale-rule-type --srt]
                           [--set-env-vars]
                           [--subscription]
                           [--tags]
                           [--workload-profile-name]
                           [--yaml]

Examples

Update a job's replica timeout.

az containerapp job update -n my-containerapp-job -g MyResourceGroup \
    --replica-timeout 10

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--args

A list of container startup command argument(s). Space-separated values e.g. "-c" "mycommand". Empty string to clear existing values.

Property	Value
Parameter group:	Container Arguments

--command

A list of supported commands on the container that will executed during startup. Space-separated values e.g. "/bin/queue" "mycommand". Empty string to clear existing values.

Property	Value
Parameter group:	Container Arguments

--container-name

Name of the container.

Property	Value
Parameter group:	Container Arguments

--cpu

Required CPU in cores from 0.25 - 2.0, e.g. 0.5.

Property	Value
Parameter group:	Container Arguments

--cron-expression

Cron expression. Only supported for trigger type "Schedule".

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--image

Container image, e.g. publisher/image-name:tag.

--max-executions

Maximum number of job executions to run per polling interval.

Property	Value
Parameter group:	Scale Arguments

--memory

Required memory from 0.5 - 4.0 ending with "Gi", e.g. 1.0Gi.

Property	Value
Parameter group:	Container Arguments

--min-executions

Minimum number of job executions to run per polling interval.

Property	Value
Parameter group:	Scale Arguments

--name -n

The name of the Container Apps Job. A name must consist of lower case alphanumeric characters or '-', start with a letter, end with an alphanumeric character, cannot have '--', and must be less than 32 characters.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--parallelism

Maximum number of replicas to run per execution.

--polling-interval

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

Property	Value
Parameter group:	Scale Arguments

--rcc --replica-completion-count

Number of replicas that need to complete successfully for execution to succeed.

--remove-all-env-vars

Remove all environment variable(s) from container..

Property	Value
Parameter group:	Environment variables Arguments
Default value:	False

--remove-env-vars

Remove environment variable(s) from container. Space-separated environment variable names.

Property	Value
Parameter group:	Environment variables Arguments

--replace-env-vars

Replace environment variable(s) in container. Other existing environment variables are removed. Space-separated values in 'key=value' format. If stored as a secret, value must start with 'secretref:' followed by the secret name.

Property	Value
Parameter group:	Environment variables Arguments

--replica-retry-limit

Maximum number of retries before the replica fails.

--replica-timeout

Maximum number of seconds a replica can execute.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--scale-rule-auth --sra

Scale rule auth parameters. Auth parameters must be in format "{triggerParameter}={secretRef} {triggerParameter}={secretRef} ...".

Property	Value
Parameter group:	Scale Arguments

--scale-rule-identity --sri

Preview

Resource ID of a managed identity to authenticate with Azure scaler resource(storage account/eventhub or else), or System to use a system-assigned identity.

Property	Value
Parameter group:	Scale Arguments

--scale-rule-metadata --srm

Scale rule metadata. Metadata must be in format "{key}={value} {key}={value} ...".

Property	Value
Parameter group:	Scale Arguments

--scale-rule-name --srn

The name of the scale rule.

Property	Value
Parameter group:	Scale Arguments

--scale-rule-type --srt

The type of the scale rule.

Property	Value
Parameter group:	Scale Arguments

--set-env-vars

Add or update environment variable(s) in container. Existing environment variables are not modified. Space-separated values in 'key=value' format. If stored as a secret, value must start with 'secretref:' followed by the secret name.

Property	Value
Parameter group:	Environment variables Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--workload-profile-name -w

The friendly name for the workload profile.

--yaml

Path to a .yaml file with the configuration of a container app. All other parameters will be ignored. For an example, see https://learn.microsoft.com/azure/container-apps/azure-resource-manager-api-spec#examples.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False