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, string, LogListOptions, CancellationToken)

Query log messages.

Required scope: Data/Buildby.Taskurai/logs/query/read

Declaration

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

Returns

Taskurai.Models.LogMessagesResponse: Taskurai.Models.LogMessagesResponse

Parameters

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

QueryMessagesAsync(string, string, LogListOptions, CancellationToken)

Query log messages.

Required scope: Data/Buildby.Taskurai/logs/query/read

Declaration

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

Returns

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

Parameters

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListConsoleMessages(string, LogListOptions, CancellationToken)

List console log messages.

Required scope: Data/Buildby.Taskurai/logs/console/read

Declaration

public virtual ConsoleLogMessagesResponse ListConsoleMessages(string hubName, LogListOptions options = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.ConsoleLogMessagesResponse: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	hubName	Hub name.
Taskurai.Models.LogListOptions	options	Taskurai.Models.LogListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListConsoleMessagesAsync(string, LogListOptions, CancellationToken)

List console log messages.

Required scope: Data/Buildby.Taskurai/logs/console/read

Declaration

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

Returns

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

Parameters

Type	Name	Description
System.String	hubName	Hub name.
Taskurai.Models.LogListOptions	options	Taskurai.Models.LogListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListSystemMessages(string, LogListOptions, CancellationToken)

List system log messages.

Required scope: Data/Buildby.Taskurai/logs/system/read

Declaration

public virtual SystemLogMessagesResponse ListSystemMessages(string hubName, LogListOptions options = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.SystemLogMessagesResponse: Taskurai.Models.SystemLogMessagesResponse

Parameters

Type	Name	Description
System.String	hubName	Hub name.
Taskurai.Models.LogListOptions	options	Taskurai.Models.LogListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListSystemMessagesAsync(string, LogListOptions, CancellationToken)

List system log messages.

Required scope: Data/Buildby.Taskurai/logs/system/read

Declaration

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

Returns

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

Parameters

Type	Name	Description
System.String	hubName	Hub name.
Taskurai.Models.LogListOptions	options	Taskurai.Models.LogListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTaskConsoleMessages(string, string, LogListOptions, CancellationToken)

List task console log messages.

Required scope: Data/Buildby.Taskurai/logs/tasks/console/read

Declaration

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

Returns

Taskurai.Models.ConsoleLogMessagesResponse: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	hubName	Hub name.
System.String	id	Task id.
Taskurai.Models.LogListOptions	options	Taskurai.Models.LogListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTaskConsoleMessagesAsync(string, string, LogListOptions, CancellationToken)

List task console log messages.

Required scope: Data/Buildby.Taskurai/logs/tasks/console/read

Declaration

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

Returns

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

Parameters

Type	Name	Description
System.String	hubName	Hub name.
System.String	id	Task id.
Taskurai.Models.LogListOptions	options	Taskurai.Models.LogListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTaskHistoryConsoleMessages(string, string, long, LogListOptions, CancellationToken)

List task history console log messages.

Required scope: Data/Buildby.Taskurai/logs/tasks/console/read

Declaration

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

Returns

Taskurai.Models.ConsoleLogMessagesResponse: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	hubName	Hub name.
System.String	id	Task id.
System.Int64	runCount	Run count.
Taskurai.Models.LogListOptions	options	Taskurai.Models.LogListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTaskHistoryConsoleMessagesAsync(string, string, long, LogListOptions, CancellationToken)

List task history console log messages.

Required scope: Data/Buildby.Taskurai/logs/tasks/console/read

Declaration

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

Returns

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

Parameters

Type	Name	Description
System.String	hubName	Hub name.
System.String	id	Task id.
System.Int64	runCount	Run count.
Taskurai.Models.LogListOptions	options	Taskurai.Models.LogListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListStepConsoleMessages(string, string, string, LogListOptions, CancellationToken)

List step console log messages.

Required scope: Data/Buildby.Taskurai/logs/tasks/console/read

Declaration

public virtual ConsoleLogMessagesResponse ListStepConsoleMessages(string hubName, string id, string stepId, LogListOptions options = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.ConsoleLogMessagesResponse: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	hubName	Hub name.
System.String	id	Task id.
System.String	stepId	Step id.
Taskurai.Models.LogListOptions	options	Taskurai.Models.LogListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListStepConsoleMessagesAsync(string, string, string, LogListOptions, CancellationToken)

List step console log messages.

Required scope: Data/Buildby.Taskurai/logs/tasks/console/read

Declaration

public virtual Task<ConsoleLogMessagesResponse> ListStepConsoleMessagesAsync(string hubName, string id, string stepId, LogListOptions options = null, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
System.String	hubName	Hub name.
System.String	id	Task id.
System.String	stepId	Step id.
Taskurai.Models.LogListOptions	options	Taskurai.Models.LogListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListStepHistoryConsoleMessages(string, string, string, long, LogListOptions, CancellationToken)

List step history console log messages.

Required scope: Data/Buildby.Taskurai/logs/tasks/console/read

Declaration

public virtual ConsoleLogMessagesResponse ListStepHistoryConsoleMessages(string hubName, string id, string stepId, long runCount, LogListOptions options = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.ConsoleLogMessagesResponse: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	hubName	Hub name.
System.String	id	Task id.
System.String	stepId	Step id.
System.Int64	runCount	Run count.
Taskurai.Models.LogListOptions	options	Taskurai.Models.LogListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListStepHistoryConsoleMessagesAsync(string, string, string, long, LogListOptions, CancellationToken)

List step history console log messages.

Required scope: Data/Buildby.Taskurai/logs/tasks/console/read

Declaration

public virtual Task<ConsoleLogMessagesResponse> ListStepHistoryConsoleMessagesAsync(string hubName, string id, string stepId, long runCount, LogListOptions options = null, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
System.String	hubName	Hub name.
System.String	id	Task id.
System.String	stepId	Step id.
System.Int64	runCount	Run count.
Taskurai.Models.LogListOptions	options	Taskurai.Models.LogListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTaskCorrelationConsoleMessages(string, string, LogListOptions, CancellationToken)

List task correlation console log messages.

Required scope: Data/Buildby.Taskurai/logs/tasks/correlation/console/read

Declaration

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

Returns

Taskurai.Models.ConsoleLogMessagesResponse: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	hubName	Hub name.
System.String	correlationId	Task correlation id.
Taskurai.Models.LogListOptions	options	Taskurai.Models.LogListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTaskCorrelationConsoleMessagesAsync(string, string, LogListOptions, CancellationToken)

List task correlation console log messages.

Required scope: Data/Buildby.Taskurai/logs/tasks/correlation/console/read

Declaration

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

Returns

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

Parameters

Type	Name	Description
System.String	hubName	Hub name.
System.String	correlationId	Task correlation id.
Taskurai.Models.LogListOptions	options	Taskurai.Models.LogListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTaskHistoryCorrelationConsoleMessages(string, string, long, LogListOptions, CancellationToken)

List task history correlation console log messages.

Required scope: Data/Buildby.Taskurai/logs/tasks/correlation/console/read

Declaration

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

Returns

Taskurai.Models.ConsoleLogMessagesResponse: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTaskHistoryCorrelationConsoleMessagesAsync(string, string, long, LogListOptions, CancellationToken)

List task history correlation console log messages.

Required scope: Data/Buildby.Taskurai/logs/tasks/correlation/console/read

Declaration

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

Returns

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

Parameters

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListCommandConsoleMessages(string, string, LogListOptions, CancellationToken)

List command console log messages.

Required scope: Data/Buildby.Taskurai/logs/commands/console/read

Declaration

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

Returns

Taskurai.Models.ConsoleLogMessagesResponse: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	hubName	Hub name.
System.String	commandName	Command name.
Taskurai.Models.LogListOptions	options	Taskurai.Models.LogListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListCommandConsoleMessagesAsync(string, string, LogListOptions, CancellationToken)

List command console log messages.

Required scope: Data/Buildby.Taskurai/logs/commands/console/read

Declaration

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

Returns

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

Parameters

Type	Name	Description
System.String	hubName	Hub name.
System.String	commandName	Command name.
Taskurai.Models.LogListOptions	options	Taskurai.Models.LogListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListWorkerConsoleMessages(string, string, LogListOptions, CancellationToken)

List worker console log messages.

Required scope: Data/Buildby.Taskurai/logs/workers/console/read

Declaration

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

Returns

Taskurai.Models.ConsoleLogMessagesResponse: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

Type	Name	Description
System.String	hubName	Hub name.
System.String	workerName	Worker name.
Taskurai.Models.LogListOptions	options	Taskurai.Models.LogListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListWorkerConsoleMessagesAsync(string, string, LogListOptions, CancellationToken)

List worker console log messages.

Required scope: Data/Buildby.Taskurai/logs/workers/console/read

Declaration

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

Returns

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

Parameters

Type	Name	Description
System.String	hubName	Hub name.
System.String	workerName	Worker name.
Taskurai.Models.LogListOptions	options	Taskurai.Models.LogListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListWorkerSystemMessages(string, string, LogListOptions, CancellationToken)

List worker system log messages.

Required scope: Data/Buildby.Taskurai/logs/workers/system/read

Declaration

public virtual SystemLogMessagesResponse ListWorkerSystemMessages(string hubName, string containerAppName, LogListOptions options = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.SystemLogMessagesResponse: Taskurai.Models.SystemLogMessagesResponse

Parameters

Type	Name	Description
System.String	hubName	Hub name.
System.String	containerAppName	Container app name.
Taskurai.Models.LogListOptions	options	Taskurai.Models.LogListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListWorkerSystemMessagesAsync(string, string, LogListOptions, CancellationToken)

List worker system log messages.

Required scope: Data/Buildby.Taskurai/logs/workers/system/read

Declaration

public virtual Task<SystemLogMessagesResponse> ListWorkerSystemMessagesAsync(string hubName, string containerAppName, LogListOptions options = null, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
System.String	hubName	Hub name.
System.String	containerAppName	Container app name.
Taskurai.Models.LogListOptions	options	Taskurai.Models.LogListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListContainerImageConsoleMessages(string, string, LogListOptions, CancellationToken)

List container image console log messages.

Required scope: Data/Buildby.Taskurai/logs/container-images/console/read

Declaration

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

Returns

Taskurai.Models.ConsoleLogMessagesResponse: Taskurai.Models.ConsoleLogMessagesResponse

Parameters

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListContainerImageConsoleMessagesAsync(string, string, LogListOptions, CancellationToken)

List container image console log messages.

Required scope: Data/Buildby.Taskurai/logs/container-images/console/read

Declaration

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

Returns

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

Parameters

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

Exceptions

Azure.RequestFailedException
Throws if request fails.