Package version:

Interface TaskRuns

Interface representing a TaskRuns.

Hierarchy

TaskRuns

Index

Methods

beginCreate beginCreateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get getDetails list

Methods

beginCreate

beginCreate(resourceGroupName: string, registryName: string, taskRunName: string, taskRun: TaskRun, options?: TaskRunsCreateOptionalParams): Promise<PollerLike<PollOperationState<TaskRun>, TaskRun>>
Creates a task run for a container registry with the specified parameters.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- taskRunName: string
  
  The name of the task run.
- taskRun: TaskRun
  
  The parameters of a run that needs to scheduled.
- Optional options: TaskRunsCreateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<TaskRun>, TaskRun>>
- Defined in operationsInterfaces/taskRuns.ts:61

beginCreateAndWait

beginCreateAndWait(resourceGroupName: string, registryName: string, taskRunName: string, taskRun: TaskRun, options?: TaskRunsCreateOptionalParams): Promise<TaskRun>
Creates a task run for a container registry with the specified parameters.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- taskRunName: string
  
  The name of the task run.
- taskRun: TaskRun
  
  The parameters of a run that needs to scheduled.
- Optional options: TaskRunsCreateOptionalParams
  
  The options parameters.
Returns Promise<TaskRun>
- Defined in operationsInterfaces/taskRuns.ts:81

beginDelete

beginDelete(resourceGroupName: string, registryName: string, taskRunName: string, options?: TaskRunsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Deletes a specified task run resource.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- taskRunName: string
  
  The name of the task run.
- Optional options: TaskRunsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/taskRuns.ts:95

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, registryName: string, taskRunName: string, options?: TaskRunsDeleteOptionalParams): Promise<void>
Deletes a specified task run resource.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- taskRunName: string
  
  The name of the task run.
- Optional options: TaskRunsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/taskRuns.ts:108

beginUpdate

beginUpdate(resourceGroupName: string, registryName: string, taskRunName: string, updateParameters: TaskRunUpdateParameters, options?: TaskRunsUpdateOptionalParams): Promise<PollerLike<PollOperationState<TaskRun>, TaskRun>>
Updates a task run with the specified parameters.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- taskRunName: string
  
  The name of the task run.
- updateParameters: TaskRunUpdateParameters
  
  The parameters for updating a task run.
- Optional options: TaskRunsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<TaskRun>, TaskRun>>
- Defined in operationsInterfaces/taskRuns.ts:122

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, registryName: string, taskRunName: string, updateParameters: TaskRunUpdateParameters, options?: TaskRunsUpdateOptionalParams): Promise<TaskRun>
Updates a task run with the specified parameters.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- taskRunName: string
  
  The name of the task run.
- updateParameters: TaskRunUpdateParameters
  
  The parameters for updating a task run.
- Optional options: TaskRunsUpdateOptionalParams
  
  The options parameters.
Returns Promise<TaskRun>
- Defined in operationsInterfaces/taskRuns.ts:142

get

get(resourceGroupName: string, registryName: string, taskRunName: string, options?: TaskRunsGetOptionalParams): Promise<TaskRun>
Gets the detailed information for a given task run.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- taskRunName: string
  
  The name of the task run.
- Optional options: TaskRunsGetOptionalParams
  
  The options parameters.
Returns Promise<TaskRun>
- Defined in operationsInterfaces/taskRuns.ts:47

getDetails

getDetails(resourceGroupName: string, registryName: string, taskRunName: string, options?: TaskRunsGetDetailsOptionalParams): Promise<TaskRun>
Gets the detailed information for a given task run that includes all secrets.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- taskRunName: string
  
  The name of the task run.
- Optional options: TaskRunsGetDetailsOptionalParams
  
  The options parameters.
Returns Promise<TaskRun>
- Defined in operationsInterfaces/taskRuns.ts:156

list

list(resourceGroupName: string, registryName: string, options?: TaskRunsListOptionalParams): PagedAsyncIterableIterator<TaskRun>
Lists all the task runs for a specified container registry.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- Optional options: TaskRunsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<TaskRun>
- Defined in operationsInterfaces/taskRuns.ts:35

Interface TaskRuns

Hierarchy

Index

Methods

Methods

beginCreate

Parameters

resourceGroupName: string

registryName: string

taskRunName: string

taskRun: TaskRun

Optional options: TaskRunsCreateOptionalParams

Returns Promise<PollerLike<PollOperationState<TaskRun>, TaskRun>>

beginCreateAndWait

Parameters

resourceGroupName: string

registryName: string

taskRunName: string

taskRun: TaskRun

Optional options: TaskRunsCreateOptionalParams

Returns Promise<TaskRun>

beginDelete

Parameters

resourceGroupName: string

registryName: string

taskRunName: string

Optional options: TaskRunsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

registryName: string

taskRunName: string

Optional options: TaskRunsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

registryName: string

taskRunName: string

updateParameters: TaskRunUpdateParameters

Optional options: TaskRunsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<TaskRun>, TaskRun>>

beginUpdateAndWait

Parameters

resourceGroupName: string

registryName: string

taskRunName: string

updateParameters: TaskRunUpdateParameters

Optional options: TaskRunsUpdateOptionalParams

Returns Promise<TaskRun>

get

Parameters

resourceGroupName: string

registryName: string

taskRunName: string

Optional options: TaskRunsGetOptionalParams

Returns Promise<TaskRun>

getDetails

Parameters

resourceGroupName: string

registryName: string

taskRunName: string

Optional options: TaskRunsGetDetailsOptionalParams

Returns Promise<TaskRun>

list

Parameters

resourceGroupName: string

registryName: string

Optional options: TaskRunsListOptionalParams

Returns PagedAsyncIterableIterator<TaskRun>

Settings

Member Visibility

Theme

`Optional` options: TaskRunsCreateOptionalParams

`Optional` options: TaskRunsCreateOptionalParams

`Optional` options: TaskRunsDeleteOptionalParams

`Optional` options: TaskRunsDeleteOptionalParams

`Optional` options: TaskRunsUpdateOptionalParams

`Optional` options: TaskRunsUpdateOptionalParams

`Optional` options: TaskRunsGetOptionalParams

`Optional` options: TaskRunsGetDetailsOptionalParams

`Optional` options: TaskRunsListOptionalParams