az batch file
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
Name of a file group from which the files will be downloaded.
Path to a local file or directory to be stored the download files.
Optional Parameters
Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.
The Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.
The Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.
If set, an existing file in the local path will be overwritten.
The subdirectory under which files exist remotely.
The resource group of the Batch account.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
Name of a file group under which the files will be stored.
Path to a local file or directory to be uploaded - can include wildcard patterns.
Optional Parameters
Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.
The Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.
The Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.
If set, will not retain local directory structure in storage.
Group subdirectory under which files will be uploaded.
The resource group of the Batch account.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.