az batch node file

Manage Batch compute node files.

Commands

Name	Description	Type	Status
az batch node file delete	Deletes the specified file from the Compute Node.	Core	GA
az batch node file download	Download the content of the a node file.	Core	GA
az batch node file list	Lists all of the files in Task directories on the specified Compute Node.	Core	GA
az batch node file show	Gets the properties of the specified Compute Node file.	Core	GA

az batch node file delete

Deletes the specified file from the Compute Node.

az batch node file delete --file-path
                          --node-id
                          --pool-id
                          [--account-endpoint]
                          [--account-key]
                          [--account-name]
                          [--recursive]
                          [--yes]

Required Parameters

--file-path

The path to the file or directory that you want to delete.

--node-id

The ID of the Compute Node from which you want to delete the file.

--pool-id

The ID of the Pool that contains the Compute Node.

Optional Parameters

--account-endpoint

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

--account-key

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

--account-name

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

--recursive

Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail.

--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 batch node file download

Download the content of the a node file.

az batch node file download --destination
                            --file-path
                            --node-id
                            --pool-id
                            [--account-endpoint]
                            [--account-key]
                            [--account-name]
                            [--end-range]
                            [--if-modified-since]
                            [--if-unmodified-since]
                            [--start-range]

Required Parameters

--destination

The path to the destination file or directory.

--file-path

The path to the Compute Node file that you want to get the content of.

--node-id

The ID of the Compute Node that contains the file.

--pool-id

The ID of the Pool that contains the Compute Node.

Optional Parameters

--account-endpoint

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

--account-key

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

--account-name

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

--end-range

The byte range to be retrieved. If not set the file will be retrieved to the end.

--if-modified-since

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

--if-unmodified-since

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

--start-range

The byte range to be retrieved. If not set the file will be retrieved from the beginning.

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 node file list

Lists all of the files in Task directories on the specified Compute Node.

az batch node file list --node-id
                        --pool-id
                        [--account-endpoint]
                        [--account-key]
                        [--account-name]
                        [--filter]
                        [--recursive]

Required Parameters

--node-id

The ID of the Compute Node whose files you want to list.

--pool-id

The ID of the Pool that contains the Compute Node.

Optional Parameters

--account-endpoint

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

--account-key

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

--account-name

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

--filter

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files.

--recursive

Whether to list children of a directory.

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 node file show

Gets the properties of the specified Compute Node file.

az batch node file show --file-path
                        --node-id
                        --pool-id
                        [--account-endpoint]
                        [--account-key]
                        [--account-name]
                        [--if-modified-since]
                        [--if-unmodified-since]

Required Parameters

--file-path

The path to the Compute Node file that you want to get the properties of.

--node-id

The ID of the Compute Node that contains the file.

--pool-id

The ID of the Pool that contains the Compute Node.

Optional Parameters

--account-endpoint

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

--account-key

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

--account-name

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

--if-modified-since

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

--if-unmodified-since

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

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.