Class TaskuraiLogsClient

A TaskuraiLogsClient provides access to the Taskurai Log api.

Assembly: Taskurai.dll

Declaration

public class TaskuraiLogsClient : TaskuraiBaseClient

Inheritance: System.Object -> Taskurai.TaskuraiBaseClient

Methods

QueryMessages(string, ListLogOptions, CancellationToken)

Query log messages.

Required scope: Taskurai.Log.Query.Read

Declaration

public virtual LogMessagesResponse QueryMessages(string query, ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.LogMessagesResponse: Taskurai.Models.LogMessagesResponse

Parameters

Type	Name	Description
System.String	query	Log query string (Kusto Query). Learn more about the Kusto Query Language (KQL).
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

QueryMessagesAsync(string, ListLogOptions, CancellationToken)

Query log messages.

Required scope: Taskurai.Log.Query.Read

Declaration

public virtual Task<LogMessagesResponse> QueryMessagesAsync(string query, ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Taskurai.Models.LogMessagesResponse>: Taskurai.Models.LogMessagesResponse

Parameters

Type	Name	Description
System.String	query	Log query string (Kusto Query). Learn more about the Kusto Query Language (KQL).
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListConsoleMessages(ListLogOptions, CancellationToken)

List console log messages.

Required scope: Taskurai.Log.Console.Read

Declaration

public virtual ConsoleLogMessagesResponse ListConsoleMessages(ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.ConsoleLogMessagesResponse: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListConsoleMessagesAsync(ListLogOptions, CancellationToken)

List console log messages.

Required scope: Taskurai.Log.Console.Read

Declaration

public virtual Task<ConsoleLogMessagesResponse> ListConsoleMessagesAsync(ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Taskurai.Models.ConsoleLogMessagesResponse>: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListSystemMessages(ListLogOptions, CancellationToken)

List system log messages.

Required scope: Taskurai.Log.System.Read

Declaration

public virtual SystemLogMessagesResponse ListSystemMessages(ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.SystemLogMessagesResponse: Taskurai.Models.SystemLogMessagesResponse

Parameters

Type	Name	Description
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListSystemMessagesAsync(ListLogOptions, CancellationToken)

List system log messages.

Required scope: Taskurai.Log.System.Read

Declaration

public virtual Task<SystemLogMessagesResponse> ListSystemMessagesAsync(ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Taskurai.Models.SystemLogMessagesResponse>: Taskurai.Models.SystemLogMessagesResponse

Parameters

Type	Name	Description
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTaskConsoleMessages(string, ListLogOptions, CancellationToken)

List task console log messages.

Required scope: Taskurai.Log.Task.Console.Read

Declaration

public virtual ConsoleLogMessagesResponse ListTaskConsoleMessages(string id, ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.ConsoleLogMessagesResponse: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	id	Task id.
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTaskConsoleMessagesAsync(string, ListLogOptions, CancellationToken)

List task console log messages.

Required scope: Taskurai.Log.Task.Console.Read

Declaration

public virtual Task<ConsoleLogMessagesResponse> ListTaskConsoleMessagesAsync(string id, ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Taskurai.Models.ConsoleLogMessagesResponse>: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	id	Task id.
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTaskHistoryConsoleMessages(string, long, ListLogOptions, CancellationToken)

List task history console log messages.

Required scope: Taskurai.Log.Task.Console.Read

Declaration

public virtual ConsoleLogMessagesResponse ListTaskHistoryConsoleMessages(string id, long runCount, ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.ConsoleLogMessagesResponse: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	id	Task id.
System.Int64	runCount	Run count.
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTaskHistoryConsoleMessagesAsync(string, long, ListLogOptions, CancellationToken)

List task history console log messages.

Required scope: Taskurai.Log.Task.Console.Read

Declaration

public virtual Task<ConsoleLogMessagesResponse> ListTaskHistoryConsoleMessagesAsync(string id, long runCount, ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Taskurai.Models.ConsoleLogMessagesResponse>: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	id	Task id.
System.Int64	runCount	Run count.
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTaskCorrelationConsoleMessages(string, ListLogOptions, CancellationToken)

List task correlation console log messages.

Required scope: Taskurai.Log.TaskCorrelation.Console.Read

Declaration

public virtual ConsoleLogMessagesResponse ListTaskCorrelationConsoleMessages(string correlationId, ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.ConsoleLogMessagesResponse: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	correlationId	Task correlation id.
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTaskCorrelationConsoleMessagesAsync(string, ListLogOptions, CancellationToken)

List task correlation console log messages.

Required scope: Taskurai.Log.TaskCorrelation.Console.Read

Declaration

public virtual Task<ConsoleLogMessagesResponse> ListTaskCorrelationConsoleMessagesAsync(string correlationId, ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Taskurai.Models.ConsoleLogMessagesResponse>: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	correlationId	Task correlation id.
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTaskHistoryCorrelationConsoleMessages(string, long, ListLogOptions, CancellationToken)

List task history correlation console log messages.

Required scope: Taskurai.Log.TaskCorrelation.Console.Read

Declaration

public virtual ConsoleLogMessagesResponse ListTaskHistoryCorrelationConsoleMessages(string correlationId, long runCount, ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.ConsoleLogMessagesResponse: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	correlationId	Task correlation id.
System.Int64	runCount	Run count.
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTaskHistoryCorrelationConsoleMessagesAsync(string, long, ListLogOptions, CancellationToken)

List task history correlation console log messages.

Required scope: Taskurai.Log.TaskCorrelation.Console.Read

Declaration

public virtual Task<ConsoleLogMessagesResponse> ListTaskHistoryCorrelationConsoleMessagesAsync(string correlationId, long runCount, ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Taskurai.Models.ConsoleLogMessagesResponse>: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	correlationId	Task correlation id.
System.Int64	runCount	Run count.
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListCommandConsoleMessages(string, ListLogOptions, CancellationToken)

List command console log messages.

Required scope: Taskurai.Log.Command.Console.Read

Declaration

public virtual ConsoleLogMessagesResponse ListCommandConsoleMessages(string commandName, ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.ConsoleLogMessagesResponse: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	commandName	Command name.
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListCommandConsoleMessagesAsync(string, ListLogOptions, CancellationToken)

List command console log messages.

Required scope: Taskurai.Log.Command.Console.Read

Declaration

public virtual Task<ConsoleLogMessagesResponse> ListCommandConsoleMessagesAsync(string commandName, ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Taskurai.Models.ConsoleLogMessagesResponse>: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	commandName	Command name.
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListWorkerConsoleMessages(string, ListLogOptions, CancellationToken)

List worker console log messages.

Required scope: Taskurai.Log.Worker.Console.Read

Declaration

public virtual ConsoleLogMessagesResponse ListWorkerConsoleMessages(string workerName, ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.ConsoleLogMessagesResponse: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	workerName	Worker name.
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListWorkerConsoleMessagesAsync(string, ListLogOptions, CancellationToken)

List worker console log messages.

Required scope: Taskurai.Log.Worker.Console.Read

Declaration

public virtual Task<ConsoleLogMessagesResponse> ListWorkerConsoleMessagesAsync(string workerName, ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Taskurai.Models.ConsoleLogMessagesResponse>: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	workerName	Worker name.
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListWorkerSystemMessages(string, ListLogOptions, CancellationToken)

List worker system log messages.

Required scope: Taskurai.Log.Worker.System.Read

Declaration

public virtual SystemLogMessagesResponse ListWorkerSystemMessages(string workerName, ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.SystemLogMessagesResponse: Taskurai.Models.SystemLogMessagesResponse

Parameters

Type	Name	Description
System.String	workerName	Worker name.
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListWorkerSystemMessagesAsync(string, ListLogOptions, CancellationToken)

List worker system log messages.

Required scope: Taskurai.Log.Worker.System.Read

Declaration

public virtual Task<SystemLogMessagesResponse> ListWorkerSystemMessagesAsync(string workerName, ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Taskurai.Models.SystemLogMessagesResponse>: Taskurai.Models.SystemLogMessagesResponse

Parameters

Type	Name	Description
System.String	workerName	Worker name.
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListContainerImageConsoleMessages(string, ListLogOptions, CancellationToken)

List container image console log messages.

Required scope: Taskurai.Log.ContainerImage.Console.Read

Declaration

public virtual ConsoleLogMessagesResponse ListContainerImageConsoleMessages(string containerImage, ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.ConsoleLogMessagesResponse: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	containerImage	Container image (e.g. taskuraisample.azurecr.io/taskurai-worker-sample:latest).
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListContainerImageConsoleMessagesAsync(string, ListLogOptions, CancellationToken)

List container image console log messages.

Required scope: Taskurai.Log.ContainerImage.Console.Read

Declaration

public virtual Task<ConsoleLogMessagesResponse> ListContainerImageConsoleMessagesAsync(string containerImage, ListLogOptions options = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Taskurai.Models.ConsoleLogMessagesResponse>: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	containerImage	Container image (e.g. taskuraisample.azurecr.io/taskurai-worker-sample:latest).
Taskurai.Models.ListLogOptions	options	Taskurai.Models.ListLogOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.