ComputeNode.UploadComputeNodeBatchServiceLogsAsync(String, DateTime, Nullable<DateTime>, IEnumerable<BatchClientBehavior>, CancellationToken) Method

Definition

Upload Azure Batch service log files from the compute node.

public System.Threading.Tasks.Task<Microsoft.Azure.Batch.UploadBatchServiceLogsResult> UploadComputeNodeBatchServiceLogsAsync (string containerUrl, DateTime startTime, DateTime? endTime = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);
member this.UploadComputeNodeBatchServiceLogsAsync : string * DateTime * Nullable<DateTime> * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.UploadBatchServiceLogsResult>
Public Function UploadComputeNodeBatchServiceLogsAsync (containerUrl As String, startTime As DateTime, Optional endTime As Nullable(Of DateTime) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of UploadBatchServiceLogsResult)

Parameters

containerUrl
System.String

The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s). The URL must include a Shared Access Signature (SAS) granting write permissions to the container.

startTime
System.DateTime

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.

endTime
System.Nullable<System.DateTime>

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. If this is omitted, the default is the current time.

additionalBehaviors
System.Collections.Generic.IEnumerable<BatchClientBehavior>

A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors.

cancellationToken
System.Threading.CancellationToken

A System.Threading.CancellationToken for controlling the lifetime of the asynchronous operation.

Returns

System.Threading.Tasks.Task<UploadBatchServiceLogsResult>

A System.Threading.Tasks.Task that represents the asynchronous operation.

Remarks

This is for gathering Azure Batch service log files in an automated fashion from nodes if you are experiencing an error and wish to escalate to Azure support. The Azure Batch service log files should be shared with Azure support to aid in debugging issues with the Batch service.

Applies to