Share via

az batch node service-logs

Manage the service log files of a Batch compute node.

Commands

Name Description Type Status
az batch node service-logs upload

Upload service logs from a specified Batch compute node.

 Core GA

az batch node service-logs upload

Edit

Upload service logs from a specified Batch compute node.

az batch node service-logs upload --node-id
                                  --pool-id
                                  [--account-endpoint]
                                  [--account-key]
                                  [--account-name]
                                  [--container-url]
                                  [--end-time]
                                  [--json-file]
                                  [--resource-id]
                                  [--start-time]

Examples

Upload logs to a storage account SAS URL

az batch node service-logs upload --pool-id pool1 --node-id node1 --start-time 2025-01-13T00:00:00Z --container-url sas_url

Required Parameters

--node-id

The ID of the Compute Node for which you want to get the Remote Desktop Protocol 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
--container-url

The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s). If a user assigned managed identity is not being used, the URL must include a Shared Access Signature (SAS) granting write permissions to the container. The SAS duration must allow enough time for the upload to finish. The start time for SAS is optional and recommended to not be specified. Required.

Property Value
Parameter group: Content Arguments
--end-time

The end of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested. If omitted, the default is to upload all logs available after the startTime. Expected format is an ISO-8601 timestamp.

Property Value
Parameter group: Content Arguments
--json-file

A file containing the content specification in JSON (formatted to match the respective REST API body). If this parameter is specified, all 'Content Arguments' are ignored.

--resource-id

The ARM resource id of the user assigned identity.

Property Value
Parameter group: Content: Identity Reference Arguments
--start-time

The start of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested. Required. Expected format is an ISO-8601 timestamp.

Property Value
Parameter group: Content 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