ComputeNode.UploadComputeNodeBatchServiceLogsAsync Method

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Overloads

UploadComputeNodeBatchServiceLogsAsync(String, DateTime, Nullable<DateTime>, IEnumerable<BatchClientBehavior>, CancellationToken)	Upload Azure Batch service log files from the compute node.
UploadComputeNodeBatchServiceLogsAsync(String, ComputeNodeIdentityReference, DateTime, Nullable<DateTime>, IEnumerable<BatchClientBehavior>, CancellationToken)	Upload Azure Batch service log files from the compute node.

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

Source:

ComputeNode.cs

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

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

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

Nullable<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

IEnumerable<BatchClientBehavior>

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

cancellationToken

CancellationToken

A CancellationToken for controlling the lifetime of the asynchronous operation.

Returns

Task<UploadBatchServiceLogsResult>

A 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.

UploadComputeNodeBatchServiceLogsAsync(String, ComputeNodeIdentityReference, DateTime, Nullable<DateTime>, IEnumerable<BatchClientBehavior>, CancellationToken)

Source:

ComputeNode.cs

Upload Azure Batch service log files from the compute node.

public System.Threading.Tasks.Task<Microsoft.Azure.Batch.UploadBatchServiceLogsResult> UploadComputeNodeBatchServiceLogsAsync (string containerUrl, Microsoft.Azure.Batch.ComputeNodeIdentityReference identityReference, DateTime startTime, DateTime? endTime = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);

member this.UploadComputeNodeBatchServiceLogsAsync : string * Microsoft.Azure.Batch.ComputeNodeIdentityReference * 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, identityReference As ComputeNodeIdentityReference, 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

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.

identityReference

ComputeNodeIdentityReference

A managed identity to use for writing to the container.

startTime

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

Nullable<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

IEnumerable<BatchClientBehavior>

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

cancellationToken

CancellationToken

A CancellationToken for controlling the lifetime of the asynchronous operation.

Returns

Task<UploadBatchServiceLogsResult>

A 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.