Share via

az batchai job file

  • Deprecated
  • Reference

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

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

Commands

Name Description Type Status
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 file list

Edit
Deprecated

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

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

List job's output files in a directory with given id if the output directory is located on mounted Azure File Share or Blob Container.

az batchai job file list --experiment
                         --job
                         --resource-group
                         --workspace
                         [--expiry]
                         [--output-directory-id]
                         [--path]

Examples

List files in the standard output directory of the job.

az batchai job file list -g MyResourceGroup -w MyWorkspace -e MyExperiment -j MyJob

List files in the standard output directory of the job. Generates output in a table format.

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

List files in a folder 'MyFolder/MySubfolder' of an output directory with id 'MODELS'.

az batchai job file list -g MyResourceGroup -w MyWorkspace -e MyExperiment -j MyJob \
    -d MODELS -p MyFolder/MySubfolder

List files in the standard output directory of the job making download URLs to remain valid for 15 minutes.

az batchai job file list -g MyResourceGroup -w MyWorkspace -e MyExperiment -j MyJob \
    --expiry 15

Required Parameters

--experiment -e

Name of experiment.

--job -j

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

--expiry

Time in minutes for how long generated download URL should remain valid.

Default value: 60
--output-directory-id -d

The Id of the job's output directory (as specified by "id" element in outputDirectories collection in the job create parameters).

Default value: stdouterr
--path -p

Relative path in the given output directory.

Default value: .
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 file stream

Edit
Deprecated

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

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

Waits for the job to create the given file and starts streaming it similar to 'tail -f' command. The command completes when the job finished execution.

az batchai job file stream --experiment
                           --file-name
                           --job
                           --resource-group
                           --workspace
                           [--output-directory-id]
                           [--path]

Examples

Stream standard output file of the job.

az batchai job file stream -g MyResourceGroup -w MyWorkspace -e MyExperiment -j MyJob \
    -f stdout.txt

Stream a file 'log.txt' from a folder 'logs' of an output directory with id 'OUTPUTS'.

az batchai job file stream -g MyResourceGroup -w MyWorkspace -e MyExperiment -j MyJob \
    -d OUTPUTS -p logs -f log.txt

Required Parameters

--experiment -e

Name of experiment.

--file-name -f

The name of the file to stream.

--job -j

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

--output-directory-id -d

The Id of the job's output directory (as specified by "id" element in outputDirectories collection in the job create parameters).

Default value: stdouterr
--path -p

Relative path in the given output directory.

Default value: .
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.