Share via

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

Edit

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 {false, true}]
                          [--yes]

Required Parameters

--file-path

The path to the file or directory. Required.

--node-id

The ID of the Compute Node. Required.

--pool-id

The ID of the Pool that contains the Compute Node. Required.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-endpoint

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

Property Value
Parameter group: Batch Account Arguments
--account-key

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

Property Value
Parameter group: Batch Account Arguments
--account-name

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

Property Value
Parameter group: Batch Account Arguments
--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. Default value is None.

Property Value
Accepted values: false, true
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az batch node file download

Edit

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 file or directory that you want to delete. Required.

--node-id

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

--pool-id

The ID of the Pool that contains the Compute Node. Required.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-endpoint

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

Property Value
Parameter group: Batch Account Arguments
--account-key

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

Property Value
Parameter group: Batch Account Arguments
--account-name

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

Property Value
Parameter group: Batch Account Arguments
--end-range

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

Property Value
Parameter group: Pre-condition and Query Arguments
--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.

Property Value
Parameter group: Pre-condition and Query Arguments
--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 been modified since the specified time.

Property Value
Parameter group: Pre-condition and Query Arguments
--start-range

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

Property Value
Parameter group: Pre-condition and Query Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az batch node file list

Edit

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 {false, true}]

Required Parameters

--node-id

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

--pool-id

The ID of the Pool that contains the Compute Node. Required.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-endpoint

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

Property Value
Parameter group: Batch Account Arguments
--account-key

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

Property Value
Parameter group: Batch Account Arguments
--account-name

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

Property Value
Parameter group: Batch Account Arguments
--filter

An OData $filter clause. For more information on constructing this filter,see https://free.blessedness.top/rest/api/batchservice/odata-filters-in-batch.

Property Value
Parameter group: Pre-condition and Query Arguments
--recursive

Whether to list children of a directory.

Property Value
Accepted values: false, true
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az batch node file show

Edit

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 file or directory that you want to delete. Required.

--node-id

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

--pool-id

The ID of the Pool that contains the Compute Node. Required.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-endpoint

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

Property Value
Parameter group: Batch Account Arguments
--account-key

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

Property Value
Parameter group: Batch Account Arguments
--account-name

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

Property Value
Parameter group: Batch Account Arguments
--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.

Property Value
Parameter group: Pre-condition and Query Arguments
--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 been modified since the specified time.

Property Value
Parameter group: Pre-condition and Query Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False