az batch file

  • Reference

Note

This reference is part of the azure-batch-cli-extensions extension for the Azure CLI (version 2.30.0 or higher). The extension will automatically install the first time you run an az batch file command. Learn more about extensions.

Manage Batch input files.

Commands

Name Description Type Status
az batch file download

Download a specified file or directory of files to the specified storage path.

 Extension GA
az batch file upload

Upload a specified file or directory of files to the specified storage path.

 Extension GA

az batch file download

Download a specified file or directory of files to the specified storage path.

az batch file download --file-group
                       --local-path
                       [--account-endpoint]
                       [--account-key]
                       [--account-name]
                       [--overwrite]
                       [--remote-path]
                       [--resource-group]

Required Parameters

--file-group

Name of a file group from which the files will be downloaded.

--local-path

Path to a local file or directory to be stored the download files.

Optional Parameters

--account-endpoint

Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.

--account-key

The Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.

--account-name

The Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.

--overwrite

If set, an existing file in the local path will be overwritten.

default value: False
--remote-path

The subdirectory under which files exist remotely.

--resource-group

The resource group of the Batch account.

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 batch file upload

Upload a specified file or directory of files to the specified storage path.

az batch file upload --file-group
                     --local-path
                     [--account-endpoint]
                     [--account-key]
                     [--account-name]
                     [--flatten]
                     [--remote-path]
                     [--resource-group]

Required Parameters

--file-group

Name of a file group under which the files will be stored.

--local-path

Path to a local file or directory to be uploaded - can include wildcard patterns.

Optional Parameters

--account-endpoint

Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.

--account-key

The Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.

--account-name

The Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.

--flatten

If set, will not retain local directory structure in storage.

--remote-path

Group subdirectory under which files will be uploaded.

--resource-group

The resource group of the Batch account.

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.