job.yml

### YamlMime:AzureCLIGroup
uid: az_containerapp_job
name: az containerapp job
importantNote: >-
  > [!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](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions.
summary: |-
  Commands to manage Container Apps jobs.
status: GA
sourceType: Core and Extension
directCommands:
- uid: az_containerapp_job_create
  name: az containerapp job create
  summary: |-
    Create a container apps job.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py
  syntax: >-
    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]
                               [--registry-identity]
                               [--registry-password]
                               [--registry-server]
                               [--registry-username]
                               [--replica-retry-limit]
                               [--replica-timeout]
                               [--scale-rule-auth]
                               [--scale-rule-metadata]
                               [--scale-rule-name]
                               [--scale-rule-type]
                               [--secrets]
                               [--tags]
                               [--trigger-type]
                               [--workload-profile-name]
                               [--yaml]
  examples:
  - summary: |-
      Create a container apps job with Trigger Type as Manual.
    syntax: >-
      az containerapp job create -n MyContainerappsjob -g MyResourceGroup \
          --trigger-type Manual \
          --replica-timeout 5 \
          --replica-retry-limit 2 \
          --replica-completion-count 1 \
          --parallelism 1 \
          --image imageName \
          --workload-profile-name my-wlp
  - summary: |-
      Create a container apps job with Trigger Type as Schedule.
    syntax: >-
      az containerapp job create -n MyContainerappsjob -g MyResourceGroup \
          --trigger-type Schedule \
          --replica-timeout 5 \
          --replica-retry-limit 2 \
          --replica-completion-count 1 \
          --parallelism 1 \
          --cron-expression "*/1 * * * *" \
          --image imageName
  - summary: |-
      Create a container apps job with Trigger Type as Event.
    syntax: >-
      az containerapp job create -n MyContainerappsjob -g MyResourceGroup \
          --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
  requiredParameters:
  - isRequired: true
    name: --name -n
    summary: |-
      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.
  - isRequired: true
    name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  optionalParameters:
  - name: --args
    summary: |-
      A list of container startup command argument(s). Space-separated values e.g. "-c" "mycommand". Empty string to clear existing values.
  - name: --command
    summary: |-
      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.
  - name: --container-name
    summary: |-
      Name of the container.
  - name: --cpu
    summary: |-
      Required CPU in cores from 0.25 - 2.0, e.g. 0.5.
  - name: --cron-expression
    summary: |-
      Cron expression. Only supported for trigger type "Schedule".
  - name: --env-vars
    summary: |-
      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.
  - name: --environment
    summary: |-
      Name or resource ID of the container app's environment.
  - name: --image
    summary: |-
      Container image, e.g. publisher/image-name:tag.
  - name: --max-executions
    summary: |-
      Maximum number of job executions to run per polling interval.
  - name: --memory
    summary: |-
      Required memory from 0.5 - 4.0 ending with "Gi", e.g. 1.0Gi.
  - name: --mi-system-assigned
    defaultValue: "False"
    summary: |-
      Boolean indicating whether to assign system-assigned identity.
  - name: --mi-user-assigned
    summary: |-
      Space-separated user identities to be assigned.
  - name: --min-executions
    summary: |-
      Minimum number of job executions to run per polling interval.
  - name: --no-wait
    defaultValue: "False"
    summary: |-
      Do not wait for the long-running operation to finish.
  - name: --parallelism
    summary: |-
      Maximum number of replicas to run per execution.
  - name: --polling-interval
    summary: |-
      Interval to check each event source in seconds. Defaults to 30s.
  - name: --rcc --replica-completion-count
    summary: |-
      Number of replicas that need to complete successfully for execution to succeed.
  - name: --registry-identity
    summary: |-
      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.
  - name: --registry-password
    summary: |-
      The password to log in to container registry. If stored as a secret, value must start with 'secretref:' followed by the secret name.
  - name: --registry-server
    summary: |-
      The container registry server hostname, e.g. myregistry.azurecr.io.
  - name: --registry-username
    summary: |-
      The username to log in to container registry.
  - name: --replica-retry-limit
    summary: |-
      Maximum number of retries before the replica fails.
  - name: --replica-timeout
    summary: |-
      Maximum number of seconds a replica can execute.
  - name: --scale-rule-auth --sra
    summary: |-
      Scale rule auth parameters. Auth parameters must be in format "<triggerParameter>=<secretRef> <triggerParameter>=<secretRef> ...".
  - name: --scale-rule-metadata --srm
    summary: |-
      Scale rule metadata. Metadata must be in format "<key>=<value> <key>=<value> ...".
  - name: --scale-rule-name --srn
    summary: |-
      The name of the scale rule.
  - name: --scale-rule-type --srt
    summary: |-
      The type of the scale rule.
  - name: --secrets -s
    summary: |-
      A list of secret(s) for the container app. Space-separated values in 'key=value' format.
  - name: --tags
    summary: |-
      Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
  - name: --trigger-type
    summary: |-
      Trigger type. Schedule | Event | Manual.
  - name: --workload-profile-name -w
    summary: |-
      The friendly name for the workload profile.
  - name: --yaml
    summary: |-
      Path to a .yaml file with the configuration of a container app. All other parameters will be ignored. For an example, see  https://docs.microsoft.com/azure/container-apps/azure-resource-manager-api-spec#examples.
- uid: az_containerapp_job_create(containerapp)
  name: az containerapp job create
  extensionSuffix: containerapp
  summary: |-
    Create a container apps job.
  status: GA
  sourceType: Extension
  syntax: >-
    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]
                               [--registry-identity]
                               [--registry-password]
                               [--registry-server]
                               [--registry-username]
                               [--replica-retry-limit]
                               [--replica-timeout]
                               [--scale-rule-auth]
                               [--scale-rule-identity]
                               [--scale-rule-metadata]
                               [--scale-rule-name]
                               [--scale-rule-type]
                               [--secrets]
                               [--tags]
                               [--trigger-type]
                               [--workload-profile-name]
                               [--yaml]
  examples:
  - summary: |-
      Create a container apps job with Trigger Type as Manual.
    syntax: >-
      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
  - summary: |-
      Create a container apps job with Trigger Type as Schedule.
    syntax: >-
      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
  - summary: |-
      Create a container apps job with Trigger Type as Event.
    syntax: >-
      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
  - summary: |-
      Create container app job with Trigger Type as Event using identity to authenticate
    syntax: >-
      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
  - summary: |-
      Create a container apps job hosted on a Connected Environment.
    syntax: >-
      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
  requiredParameters:
  - isRequired: true
    name: --name -n
    summary: |-
      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.
  - isRequired: true
    name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  optionalParameters:
  - name: --args
    summary: |-
      A list of container startup command argument(s). Space-separated values e.g. "-c" "mycommand". Empty string to clear existing values.
  - name: --command
    summary: |-
      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.
  - name: --container-name
    summary: |-
      Name of the container.
  - name: --cpu
    summary: |-
      Required CPU in cores from 0.25 - 2.0, e.g. 0.5.
  - name: --cron-expression
    summary: |-
      Cron expression. Only supported for trigger type "Schedule".
  - name: --env-vars
    summary: |-
      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.
  - name: --environment
    summary: |-
      Name or resource ID of the container app's environment.
  - name: --environment-type
    defaultValue: "managed"
    parameterValueGroup: "connected, managed"
    summary: |-
      Type of environment.
    isPreview: true
  - name: --image
    summary: |-
      Container image, e.g. publisher/image-name:tag.
  - name: --max-executions
    defaultValue: "100"
    summary: |-
      Maximum number of job executions that are created for a trigger.
  - name: --memory
    summary: |-
      Required memory from 0.5 - 4.0 ending with "Gi", e.g. 1.0Gi.
  - name: --mi-system-assigned
    defaultValue: "False"
    summary: |-
      Boolean indicating whether to assign system-assigned identity.
  - name: --mi-user-assigned
    summary: |-
      Space-separated user identities to be assigned.
  - name: --min-executions
    defaultValue: "0"
    summary: |-
      Minimum number of job executions that are created for a trigger. Default: 0.
  - name: --no-wait
    defaultValue: "False"
    summary: |-
      Do not wait for the long-running operation to finish.
  - name: --parallelism
    defaultValue: "1"
    summary: |-
      Maximum number of replicas to run per execution.
  - name: --polling-interval
    defaultValue: "30"
    summary: |-
      Interval to check each event source in seconds.
  - name: --rcc --replica-completion-count
    defaultValue: "1"
    summary: |-
      Number of replicas that need to complete successfully for execution to succeed.
  - name: --registry-identity
    summary: |-
      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 ...').
  - name: --registry-password
    summary: |-
      The password to log in to container registry. If stored as a secret, value must start with 'secretref:' followed by the secret name.
  - name: --registry-server
    summary: |-
      The container registry server hostname, e.g. myregistry.azurecr.io.
  - name: --registry-username
    summary: |-
      The username to log in to container registry.
  - name: --replica-retry-limit
    defaultValue: "0"
    summary: |-
      Maximum number of retries before the replica fails. Default: 0.
  - name: --replica-timeout
    defaultValue: "1800"
    summary: |-
      Maximum number of seconds a replica can execute.
  - name: --scale-rule-auth --sra
    summary: |-
      Scale rule auth parameters. Auth parameters must be in format "<triggerParameter>=<secretRef> <triggerParameter>=<secretRef> ...".
  - name: --scale-rule-identity --sri
    summary: |-
      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.
    isPreview: true
  - name: --scale-rule-metadata --srm
    summary: |-
      Scale rule metadata. Metadata must be in format "<key>=<value> <key>=<value> ...".
  - name: --scale-rule-name --srn
    summary: |-
      The name of the scale rule.
  - name: --scale-rule-type --srt
    summary: |-
      The type of the scale rule.
  - name: --secrets -s
    summary: |-
      A list of secret(s) for the container app. Space-separated values in 'key=value' format.
  - name: --tags
    summary: |-
      Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
  - name: --trigger-type
    summary: |-
      Trigger type. Schedule | Event | Manual.
  - name: --workload-profile-name -w
    summary: |-
      The friendly name for the workload profile.
  - name: --yaml
    summary: |-
      Path to a .yaml file with the configuration of a container app. All other parameters will be ignored. For an example, see  https://docs.microsoft.com/azure/container-apps/azure-resource-manager-api-spec#examples.
- uid: az_containerapp_job_delete
  name: az containerapp job delete
  summary: |-
    Delete a Container Apps Job.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py
  syntax: >-
    az containerapp job delete [--ids]
                               [--name]
                               [--no-wait]
                               [--resource-group]
                               [--subscription]
                               [--yes]
  examples:
  - summary: |-
      Delete a job.
    syntax: az containerapp job delete -n my-containerapp-job -g MyResourceGroup
  optionalParameters:
  - name: --ids
    summary: |-
      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.
  - name: --name -n
    summary: |-
      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.
  - name: --no-wait
    defaultValue: "False"
    summary: |-
      Do not wait for the long-running operation to finish.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
  - name: --yes -y
    defaultValue: "False"
    summary: |-
      Do not prompt for confirmation.
- uid: az_containerapp_job_delete(containerapp)
  name: az containerapp job delete
  extensionSuffix: containerapp
  summary: |-
    Delete a Container Apps Job.
  status: GA
  sourceType: Extension
  syntax: >-
    az containerapp job delete [--ids]
                               [--name]
                               [--no-wait]
                               [--resource-group]
                               [--subscription]
                               [--yes]
  examples:
  - summary: |-
      Delete a job.
    syntax: az containerapp job delete -n my-containerapp-job -g MyResourceGroup
  optionalParameters:
  - name: --ids
    summary: |-
      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.
  - name: --name -n
    summary: |-
      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.
  - name: --no-wait
    defaultValue: "False"
    summary: |-
      Do not wait for the long-running operation to finish.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
  - name: --yes -y
    defaultValue: "False"
    summary: |-
      Do not prompt for confirmation.
- uid: az_containerapp_job_list
  name: az containerapp job list
  summary: |-
    List Container Apps Job by subscription or resource group.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py
  syntax: az containerapp job list [--resource-group]
  examples:
  - summary: |-
      List jobs in the current subscription.
    syntax: az containerapp job list
  - summary: |-
      List environments by resource group.
    syntax: az containerapp job list -g MyResourceGroup
  optionalParameters:
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- uid: az_containerapp_job_list(containerapp)
  name: az containerapp job list
  extensionSuffix: containerapp
  summary: |-
    List Container Apps Job by subscription or resource group.
  status: GA
  sourceType: Extension
  syntax: az containerapp job list [--resource-group]
  examples:
  - summary: |-
      List jobs in the current subscription.
    syntax: az containerapp job list
  - summary: |-
      List environments by resource group.
    syntax: az containerapp job list -g MyResourceGroup
  optionalParameters:
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- uid: az_containerapp_job_show
  name: az containerapp job show
  summary: |-
    Show details of a Container Apps Job.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py
  syntax: >-
    az containerapp job show [--ids]
                             [--name]
                             [--resource-group]
                             [--subscription]
  examples:
  - summary: |-
      Show the details of a job.
    syntax: az containerapp job show -n my-containerapp-job -g MyResourceGroup
  optionalParameters:
  - name: --ids
    summary: |-
      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.
  - name: --name -n
    summary: |-
      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.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- uid: az_containerapp_job_show(containerapp)
  name: az containerapp job show
  extensionSuffix: containerapp
  summary: |-
    Show details of a Container Apps Job.
  status: GA
  sourceType: Extension
  syntax: >-
    az containerapp job show [--ids]
                             [--name]
                             [--resource-group]
                             [--subscription]
  examples:
  - summary: |-
      Show the details of a job.
    syntax: az containerapp job show -n my-containerapp-job -g MyResourceGroup
  optionalParameters:
  - name: --ids
    summary: |-
      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.
  - name: --name -n
    summary: |-
      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.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- uid: az_containerapp_job_start
  name: az containerapp job start
  summary: |-
    Start a Container Apps Job execution.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py
  syntax: >-
    az containerapp job start [--args]
                              [--command]
                              [--container-name]
                              [--cpu]
                              [--env-vars]
                              [--ids]
                              [--image]
                              [--memory]
                              [--name]
                              [--no-wait]
                              [--registry-identity]
                              [--resource-group]
                              [--subscription]
                              [--yaml]
  examples:
  - summary: |-
      Start a job execution.
    syntax: az containerapp job start -n my-containerapp-job -g MyResourceGroup
  - summary: |-
      Start a job with different image and configurations.
    syntax: az containerapp job start -n my-containerapp-job -g MyResourceGroup --image MyImageName --cpu 0.5 --memory 1.0Gi
  optionalParameters:
  - name: --args
    summary: |-
      A list of container startup command argument(s). Space-separated values e.g. "-c" "mycommand". Empty string to clear existing values.
  - name: --command
    summary: |-
      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.
  - name: --container-name
    summary: |-
      Name of the container.
  - name: --cpu
    summary: |-
      Required CPU in cores from 0.25 - 2.0, e.g. 0.5.
  - name: --env-vars
    summary: |-
      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.
  - name: --ids
    summary: |-
      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.
  - name: --image
    summary: |-
      Container image, e.g. publisher/image-name:tag.
  - name: --memory
    summary: |-
      Required memory from 0.5 - 4.0 ending with "Gi", e.g. 1.0Gi.
  - name: --name -n
    summary: |-
      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.
  - name: --no-wait
    defaultValue: "False"
    summary: |-
      Do not wait for the long-running operation to finish.
  - name: --registry-identity
    summary: |-
      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.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
  - name: --yaml
    summary: |-
      Path to a .yaml file with the configuration of a container app. All other parameters will be ignored. For an example, see  https://docs.microsoft.com/azure/container-apps/azure-resource-manager-api-spec#examples.
- uid: az_containerapp_job_stop
  name: az containerapp job stop
  summary: |-
    Stops a Container Apps Job execution.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py
  syntax: >-
    az containerapp job stop [--ids]
                             [--job-execution-name]
                             [--name]
                             [--no-wait]
                             [--resource-group]
                             [--subscription]
  examples:
  - summary: |-
      Stop a job execution.
    syntax: az containerapp job stop -n my-containerapp-job -g MyResourceGroup
  - summary: |-
      Stop a job execution giving a specific job execution name.
    syntax: az containerapp job stop -n my-containerapp-job -g MyResourceGroup --job-execution-name MyContainerAppJob-66v9xh0
  - summary: |-
      Stop all running job executions.
    syntax: az containerapp job stop -n my-containerapp-job -g MyResourceGroup
  optionalParameters:
  - name: --ids
    summary: |-
      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.
  - name: --job-execution-name
    summary: |-
      Name of the specific job execution which needs to be stopped.
  - name: --name -n
    summary: |-
      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.
  - name: --no-wait
    defaultValue: "False"
    summary: |-
      Do not wait for the long-running operation to finish.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- uid: az_containerapp_job_update
  name: az containerapp job update
  summary: |-
    Update a Container Apps Job.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py
  syntax: >-
    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]
                               [--remove-all-env-vars]
                               [--remove-env-vars]
                               [--replace-env-vars]
                               [--replica-retry-limit]
                               [--replica-timeout]
                               [--resource-group]
                               [--scale-rule-auth]
                               [--scale-rule-metadata]
                               [--scale-rule-name]
                               [--scale-rule-type]
                               [--set-env-vars]
                               [--subscription]
                               [--tags]
                               [--workload-profile-name]
                               [--yaml]
  examples:
  - summary: |-
      Update a job's replica timeout.
    syntax: >-
      az containerapp job update -n my-containerapp-job -g MyResourceGroup \
          --replica-timeout 10
  optionalParameters:
  - name: --args
    summary: |-
      A list of container startup command argument(s). Space-separated values e.g. "-c" "mycommand". Empty string to clear existing values.
  - name: --command
    summary: |-
      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.
  - name: --container-name
    summary: |-
      Name of the container.
  - name: --cpu
    summary: |-
      Required CPU in cores from 0.25 - 2.0, e.g. 0.5.
  - name: --cron-expression
    summary: |-
      Cron expression. Only supported for trigger type "Schedule".
  - name: --ids
    summary: |-
      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.
  - name: --image
    summary: |-
      Container image, e.g. publisher/image-name:tag.
  - name: --max-executions
    summary: |-
      Maximum number of job executions to run per polling interval.
  - name: --memory
    summary: |-
      Required memory from 0.5 - 4.0 ending with "Gi", e.g. 1.0Gi.
  - name: --min-executions
    summary: |-
      Minimum number of job executions to run per polling interval.
  - name: --name -n
    summary: |-
      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.
  - name: --no-wait
    defaultValue: "False"
    summary: |-
      Do not wait for the long-running operation to finish.
  - name: --parallelism
    summary: |-
      Maximum number of replicas to run per execution.
  - name: --polling-interval
    summary: |-
      Interval to check each event source in seconds. Defaults to 30s.
  - name: --rcc --replica-completion-count
    summary: |-
      Number of replicas that need to complete successfully for execution to succeed.
  - name: --remove-all-env-vars
    defaultValue: "False"
    summary: |-
      Remove all environment variable(s) from container..
  - name: --remove-env-vars
    summary: |-
      Remove environment variable(s) from container. Space-separated environment variable names.
  - name: --replace-env-vars
    summary: |-
      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.
  - name: --replica-retry-limit
    summary: |-
      Maximum number of retries before the replica fails.
  - name: --replica-timeout
    summary: |-
      Maximum number of seconds a replica can execute.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --scale-rule-auth --sra
    summary: |-
      Scale rule auth parameters. Auth parameters must be in format "<triggerParameter>=<secretRef> <triggerParameter>=<secretRef> ...".
  - name: --scale-rule-metadata --srm
    summary: |-
      Scale rule metadata. Metadata must be in format "<key>=<value> <key>=<value> ...".
  - name: --scale-rule-name --srn
    summary: |-
      The name of the scale rule.
  - name: --scale-rule-type --srt
    summary: |-
      The type of the scale rule.
  - name: --set-env-vars
    summary: |-
      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.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
  - name: --tags
    summary: |-
      Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
  - name: --workload-profile-name -w
    summary: |-
      The friendly name for the workload profile.
  - name: --yaml
    summary: |-
      Path to a .yaml file with the configuration of a container app. All other parameters will be ignored. For an example, see  https://docs.microsoft.com/azure/container-apps/azure-resource-manager-api-spec#examples.
- uid: az_containerapp_job_update(containerapp)
  name: az containerapp job update
  extensionSuffix: containerapp
  summary: |-
    Update a Container Apps Job.
  status: GA
  sourceType: Extension
  syntax: >-
    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]
                               [--remove-all-env-vars]
                               [--remove-env-vars]
                               [--replace-env-vars]
                               [--replica-retry-limit]
                               [--replica-timeout]
                               [--resource-group]
                               [--scale-rule-auth]
                               [--scale-rule-identity]
                               [--scale-rule-metadata]
                               [--scale-rule-name]
                               [--scale-rule-type]
                               [--set-env-vars]
                               [--subscription]
                               [--tags]
                               [--workload-profile-name]
                               [--yaml]
  examples:
  - summary: |-
      Update a job's replica timeout.
    syntax: >-
      az containerapp job update -n my-containerapp-job -g MyResourceGroup \
          --replica-timeout 10
  optionalParameters:
  - name: --args
    summary: |-
      A list of container startup command argument(s). Space-separated values e.g. "-c" "mycommand". Empty string to clear existing values.
  - name: --command
    summary: |-
      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.
  - name: --container-name
    summary: |-
      Name of the container.
  - name: --cpu
    summary: |-
      Required CPU in cores from 0.25 - 2.0, e.g. 0.5.
  - name: --cron-expression
    summary: |-
      Cron expression. Only supported for trigger type "Schedule".
  - name: --ids
    summary: |-
      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.
  - name: --image
    summary: |-
      Container image, e.g. publisher/image-name:tag.
  - name: --max-executions
    summary: |-
      Maximum number of job executions to run per polling interval.
  - name: --memory
    summary: |-
      Required memory from 0.5 - 4.0 ending with "Gi", e.g. 1.0Gi.
  - name: --min-executions
    summary: |-
      Minimum number of job executions to run per polling interval.
  - name: --name -n
    summary: |-
      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.
  - name: --no-wait
    defaultValue: "False"
    summary: |-
      Do not wait for the long-running operation to finish.
  - name: --parallelism
    summary: |-
      Maximum number of replicas to run per execution.
  - name: --polling-interval
    summary: |-
      Interval to check each event source in seconds. Defaults to 30s.
  - name: --rcc --replica-completion-count
    summary: |-
      Number of replicas that need to complete successfully for execution to succeed.
  - name: --remove-all-env-vars
    defaultValue: "False"
    summary: |-
      Remove all environment variable(s) from container..
  - name: --remove-env-vars
    summary: |-
      Remove environment variable(s) from container. Space-separated environment variable names.
  - name: --replace-env-vars
    summary: |-
      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.
  - name: --replica-retry-limit
    summary: |-
      Maximum number of retries before the replica fails.
  - name: --replica-timeout
    summary: |-
      Maximum number of seconds a replica can execute.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --scale-rule-auth --sra
    summary: |-
      Scale rule auth parameters. Auth parameters must be in format "<triggerParameter>=<secretRef> <triggerParameter>=<secretRef> ...".
  - name: --scale-rule-identity --sri
    summary: |-
      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.
    isPreview: true
  - name: --scale-rule-metadata --srm
    summary: |-
      Scale rule metadata. Metadata must be in format "<key>=<value> <key>=<value> ...".
  - name: --scale-rule-name --srn
    summary: |-
      The name of the scale rule.
  - name: --scale-rule-type --srt
    summary: |-
      The type of the scale rule.
  - name: --set-env-vars
    summary: |-
      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.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
  - name: --tags
    summary: |-
      Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
  - name: --workload-profile-name -w
    summary: |-
      The friendly name for the workload profile.
  - name: --yaml
    summary: |-
      Path to a .yaml file with the configuration of a container app. All other parameters will be ignored. For an example, see  https://docs.microsoft.com/azure/container-apps/azure-resource-manager-api-spec#examples.
commands:
- az_containerapp_job_create
- az_containerapp_job_create(containerapp)
- az_containerapp_job_delete
- az_containerapp_job_delete(containerapp)
- az_containerapp_job_execution
- az_containerapp_job_execution_list
- az_containerapp_job_execution_show
- az_containerapp_job_identity
- az_containerapp_job_identity_assign
- az_containerapp_job_identity_remove
- az_containerapp_job_identity_show
- az_containerapp_job_list
- az_containerapp_job_list(containerapp)
- az_containerapp_job_logs
- az_containerapp_job_logs_show
- az_containerapp_job_registry
- az_containerapp_job_registry_list
- az_containerapp_job_registry_remove
- az_containerapp_job_registry_set
- az_containerapp_job_registry_set(containerapp)
- az_containerapp_job_registry_show
- az_containerapp_job_replica
- az_containerapp_job_replica_list
- az_containerapp_job_secret
- az_containerapp_job_secret_list
- az_containerapp_job_secret_remove
- az_containerapp_job_secret_set
- az_containerapp_job_secret_show
- az_containerapp_job_show
- az_containerapp_job_show(containerapp)
- az_containerapp_job_start
- az_containerapp_job_stop
- az_containerapp_job_update
- az_containerapp_job_update(containerapp)
globalParameters:
- name: --debug
  summary: |-
    Increase logging verbosity to show all debug logs.
- name: --help -h
  summary: |-
    Show this help message and exit.
- name: --only-show-errors
  summary: |-
    Only show errors, suppressing warnings.
- name: --output -o
  defaultValue: "json"
  parameterValueGroup: "json, jsonc, none, table, tsv, yaml, yamlc"
  summary: |-
    Output format.
- name: --query
  summary: |-
    JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
- name: --subscription
  summary: |-
    Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --verbose
  summary: |-
    Increase logging verbosity. Use --debug for full debug logs.
metadata:
  description: Commands to manage Container Apps jobs.