az batchai job

  • Deprecated
  • Reference

This command group is implicitly deprecated because command group 'batchai' is deprecated and will be removed in a future release.

Commands to manage jobs.

Commands

Name Description Type Status
az batchai job create

Create a job.

 Core Deprecated
az batchai job delete

Delete a job.

 Core Deprecated
az batchai job file

Commands to list and stream files in job's output directories.

 Core Deprecated
az batchai job file list

List job's output files in a directory with given id.

 Core Deprecated
az batchai job file stream

Stream the content of a file (similar to 'tail -f').

 Core Deprecated
az batchai job list

List jobs.

 Core Deprecated
az batchai job node

Commands to work with nodes which executed a job.

 Core Deprecated
az batchai job node exec

Executes a command line on a cluster's node used to execute the job with optional ports forwarding.

 Core Deprecated
az batchai job node list

List remote login information for nodes which executed the job.

 Core Deprecated
az batchai job show

Show information about a job.

 Core Deprecated
az batchai job terminate

Terminate a job.

 Core Deprecated
az batchai job wait

Waits for specified job completion and setups the exit code to the job's exit code.

 Core Deprecated

az batchai job create

Edit
Deprecated

This command is implicitly deprecated because command group 'batchai' is deprecated and will be removed in a future release.

Create a job.

az batchai job create --cluster
                      --config-file
                      --experiment
                      --name
                      --resource-group
                      --workspace
                      [--afs-mount-path]
                      [--afs-name]
                      [--bfs-mount-path]
                      [--bfs-name]
                      [--nfs]
                      [--nfs-mount-path]
                      [--storage-account-key]
                      [--storage-account-name]

Examples

Create a job to run on a cluster in the same resource group.

az batchai job create -g MyResourceGroup -w MyWorkspace -e MyExperiment -n MyJob \
    -c MyCluster -f job.json

Create a job to run on a cluster in a different workspace.

az batchai job create -g MyJobResourceGroup -w MyJobWorkspace -e MyExperiment -n MyJob \
    -f job.json \
    -c "/subscriptions/00000000-0000-0000-0000-000000000000/\
    resourceGroups/MyClusterResourceGroup/\
    providers/Microsoft.BatchAI/workspaces/MyClusterWorkspace/clusters/MyCluster"

Create a job. (autogenerated)

az batchai job create --cluster "/subscriptions/00000000-0000-0000-0000-000000000000/\
    resourceGroups/MyClusterResourceGroup/\
    providers/Microsoft.BatchAI/workspaces/MyClusterWorkspace/clusters/MyCluster" --config-file job.json --experiment MyExperiment --name MyJob --resource-group MyJobResourceGroup --storage-account-name MyStorageAccount --workspace MyJobWorkspace

Required Parameters

--cluster -c

Name or ARM ID of the cluster to run the job. You need to provide ARM ID if the cluster belongs to a different workspace.

--config-file -f

A path to a json file containing job create parameters (json representation of azure.mgmt.batchai.models.JobCreateParameters).

--experiment -e

Name of experiment.

--name -n

Name of job.

--resource-group -g

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

--workspace -w

Name of workspace.

Optional Parameters

--afs-mount-path

Relative mount path for Azure File Share. The File Share will be available at $AZ_BATCHAI_JOB_MOUNT_ROOT/<relative_mount_path> folder.

default value: afs
--afs-name

Name of Azure File Share to mount during the job execution. The File Share will be mounted only on the nodes which are executing the job. Must be used in conjunction with --storage-account-name. Multiple shares can be mounted using configuration file (see --config-file option).

--bfs-mount-path

Relative mount path for Azure Storage Blob Container. The container will be available at $AZ_BATCHAI_JOB_MOUNT_ROOT/<relative_mount_path> folder.

default value: bfs
--bfs-name

Name of Azure Storage Blob Container to mount during the job execution. The container will be mounted only on the nodes which are executing the job. Must be used in conjunction with --storage-account-name. Multiple containers can be mounted using configuration file (see --config-file option).

--nfs

Name or ARM ID of the file server to be mounted during the job execution. You need to provide ARM ID if the file server belongs to a different workspace. You can configure multiple file servers using job's configuration file.

--nfs-mount-path

Relative mount path for NFS. The NFS will be available at $AZ_BATCHAI_JOB_MOUNT_ROOT/<relative_mount_path> folder.

default value: nfs
--storage-account-key

Storage account key. Required if the storage account belongs to a different subscription. Can be specified using AZURE_BATCHAI_STORAGE_KEY environment variable.

--storage-account-name

Storage account name for Azure File Shares and/or Azure Storage Containers to be mounted on each cluster node. Can be specified using AZURE_BATCHAI_STORAGE_ACCOUNT environment variable.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az batchai job delete

Edit
Deprecated

This command is implicitly deprecated because command group 'batchai' is deprecated and will be removed in a future release.

Delete a job.

az batchai job delete [--experiment]
                      [--ids]
                      [--name]
                      [--no-wait]
                      [--resource-group]
                      [--subscription]
                      [--workspace]
                      [--yes]

Examples

Delete a job. The job will be terminated if it's currently running.

az batchai job delete -g MyResourceGroup -w MyWorkspace -e MyExperiment -n MyJob

Delete a job without asking for confirmation (for non-interactive scenarios).

az batchai job delete -g MyResourceGroup -w MyWorkspace -e MyExperiment -n MyJob -y

Request job deletion without waiting for job to be deleted.

az batchai job delete -g MyResourceGroup -w MyWorkspace -e MyExperiment -n MyJob --no-wait

Optional Parameters

--experiment -e

Name of experiment.

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

--name -n

Name of job.

--no-wait

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

default value: False
--resource-group -g

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

--subscription

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

--workspace -w

Name of workspace.

--yes -y

Do not prompt for confirmation.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az batchai job list

Edit
Deprecated

This command is implicitly deprecated because command group 'batchai' is deprecated and will be removed in a future release.

List jobs.

az batchai job list --experiment
                    --resource-group
                    --workspace

Examples

List jobs.

az batchai job list -g MyResourceGroup -w MyWorkspace -e MyExperiment -o table

Required Parameters

--experiment -e

Name of experiment.

--resource-group -g

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

--workspace -w

Name of workspace.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az batchai job show

Edit
Deprecated

This command is implicitly deprecated because command group 'batchai' is deprecated and will be removed in a future release.

Show information about a job.

az batchai job show [--experiment]
                    [--ids]
                    [--name]
                    [--resource-group]
                    [--subscription]
                    [--workspace]

Examples

Show full information about a job.

az batchai job show -g MyResourceGroup -w MyWorkspace -e MyExperiment -n MyJob

Show job's summary.

az batchai job show -g MyResourceGroup -w MyWorkspace -e MyExperiment -n MyJob -o table

Optional Parameters

--experiment -e

Name of experiment.

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

--name -n

Name of job.

--resource-group -g

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

--subscription

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

--workspace -w

Name of workspace.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az batchai job terminate

Edit
Deprecated

This command is implicitly deprecated because command group 'batchai' is deprecated and will be removed in a future release.

Terminate a job.

az batchai job terminate [--experiment]
                         [--ids]
                         [--name]
                         [--no-wait]
                         [--resource-group]
                         [--subscription]
                         [--workspace]
                         [--yes]

Examples

Terminate a job and wait for the job to be terminated.

az batchai job terminate -g MyResourceGroup -w MyWorkspace -e MyExperiment -n MyJob

Terminate a job without asking for confirmation (for non-interactive scenarios).

az batchai job terminate -g MyResourceGroup  -w MyWorkspace -e MyExperiment -n MyJob -y

Request job termination without waiting for the job to be terminated.

az batchai job terminate -g MyResourceGroup -e MyExperiment -w MyWorkspace -n MyJob \
    --no-wait

Optional Parameters

--experiment -e

Name of experiment.

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

--name -n

Name of job.

--no-wait

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

default value: False
--resource-group -g

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

--subscription

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

--workspace -w

Name of workspace.

--yes -y

Do not prompt for confirmation.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az batchai job wait

Edit
Deprecated

This command is implicitly deprecated because command group 'batchai' is deprecated and will be removed in a future release.

Waits for specified job completion and setups the exit code to the job's exit code.

az batchai job wait [--experiment]
                    [--ids]
                    [--interval]
                    [--name]
                    [--resource-group]
                    [--subscription]
                    [--workspace]

Examples

Wait for the job completion.

az batchai job wait -g MyResourceGroup -w MyWorkspace -n MyJob

Optional Parameters

--experiment -e

Name of experiment.

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

--interval

Polling interval in sec.

default value: 15
--name -n

Name of job.

--resource-group -g

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

--subscription

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

--workspace -w

Name of workspace.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.