TasksOperations interface

Package:

@azure/ai-discovery

Interface representing a Tasks operations.

Properties

addComment	Add a comment to a task.
addExecutionHistory	Add an execution history entry to a task.
create	Create a new task.
deleteTask	Delete a task by ID.
get	Get a task by ID.
list	List tasks with optional OData filters.
start	Start execution of a task.
update	Patch (partial update) a task (e.g. status, description, validation requirements, dependencies, result).

Property Details

addComment

Add a comment to a task.

addComment: (projectName: string, investigationName: string, taskName: string, body: TaskComment, options?: TasksAddCommentOptionalParams) => Promise<Task>

Property Value

(projectName: string, investigationName: string, taskName: string, body: TaskComment, options?: TasksAddCommentOptionalParams) => Promise<Task>

addExecutionHistory

Add an execution history entry to a task.

addExecutionHistory: (projectName: string, investigationName: string, taskName: string, body: ExecutionHistoryEntry, options?: TasksAddExecutionHistoryOptionalParams) => Promise<Task>

Property Value

(projectName: string, investigationName: string, taskName: string, body: ExecutionHistoryEntry, options?: TasksAddExecutionHistoryOptionalParams) => Promise<Task>

create

Create a new task.

create: (projectName: string, investigationName: string, body: TaskCreateOrUpdateContent, options?: TasksCreateOptionalParams) => Promise<Task>

Property Value

(projectName: string, investigationName: string, body: TaskCreateOrUpdateContent, options?: TasksCreateOptionalParams) => Promise<Task>

deleteTask

Delete a task by ID.

deleteTask: (projectName: string, investigationName: string, taskName: string, options?: TasksDeleteOptionalParams) => Promise<void>

Property Value

(projectName: string, investigationName: string, taskName: string, options?: TasksDeleteOptionalParams) => Promise<void>

get

Get a task by ID.

get: (projectName: string, investigationName: string, taskName: string, options?: TasksGetOptionalParams) => Promise<Task>

Property Value

(projectName: string, investigationName: string, taskName: string, options?: TasksGetOptionalParams) => Promise<Task>

list

List tasks with optional OData filters.

list: (projectName: string, investigationName: string, options?: TasksListOptionalParams) => PagedAsyncIterableIterator<Task, Task[], PageSettings>

Property Value

(projectName: string, investigationName: string, options?: TasksListOptionalParams) => PagedAsyncIterableIterator<Task, Task[], PageSettings>

start

Start execution of a task.

start: (projectName: string, investigationName: string, taskName: string, options?: TasksStartOptionalParams) => Promise<Task>

Property Value

(projectName: string, investigationName: string, taskName: string, options?: TasksStartOptionalParams) => Promise<Task>

update

Patch (partial update) a task (e.g. status, description, validation requirements, dependencies, result).

update: (projectName: string, investigationName: string, taskName: string, resource: TaskCreateOrUpdateContent, options?: TasksUpdateOptionalParams) => Promise<Task>

Property Value

(projectName: string, investigationName: string, taskName: string, resource: TaskCreateOrUpdateContent, options?: TasksUpdateOptionalParams) => Promise<Task>