Package version:

Interface PipelineRuns

Interface representing a PipelineRuns.

Hierarchy

PipelineRuns

Index

Methods

beginCreate beginCreateAndWait beginDelete beginDeleteAndWait get list

Methods

beginCreate

beginCreate(resourceGroupName: string, registryName: string, pipelineRunName: string, pipelineRunCreateParameters: PipelineRun, options?: PipelineRunsCreateOptionalParams): Promise<PollerLike<PollOperationState<PipelineRun>, PipelineRun>>
Creates a pipeline 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.
- pipelineRunName: string
  
  The name of the pipeline run.
- pipelineRunCreateParameters: PipelineRun
  
  The parameters for creating a pipeline run.
- Optional options: PipelineRunsCreateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<PipelineRun>, PipelineRun>>
- Defined in operationsInterfaces/pipelineRuns.ts:56

beginCreateAndWait

beginCreateAndWait(resourceGroupName: string, registryName: string, pipelineRunName: string, pipelineRunCreateParameters: PipelineRun, options?: PipelineRunsCreateOptionalParams): Promise<PipelineRun>
Creates a pipeline 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.
- pipelineRunName: string
  
  The name of the pipeline run.
- pipelineRunCreateParameters: PipelineRun
  
  The parameters for creating a pipeline run.
- Optional options: PipelineRunsCreateOptionalParams
  
  The options parameters.
Returns Promise<PipelineRun>
- Defined in operationsInterfaces/pipelineRuns.ts:76

beginDelete

beginDelete(resourceGroupName: string, registryName: string, pipelineRunName: string, options?: PipelineRunsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Deletes a pipeline run from a 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.
- pipelineRunName: string
  
  The name of the pipeline run.
- Optional options: PipelineRunsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/pipelineRuns.ts:90

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, registryName: string, pipelineRunName: string, options?: PipelineRunsDeleteOptionalParams): Promise<void>
Deletes a pipeline run from a 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.
- pipelineRunName: string
  
  The name of the pipeline run.
- Optional options: PipelineRunsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/pipelineRuns.ts:103

get

get(resourceGroupName: string, registryName: string, pipelineRunName: string, options?: PipelineRunsGetOptionalParams): Promise<PipelineRun>
Gets the detailed information for a given pipeline run.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- pipelineRunName: string
  
  The name of the pipeline run.
- Optional options: PipelineRunsGetOptionalParams
  
  The options parameters.
Returns Promise<PipelineRun>
- Defined in operationsInterfaces/pipelineRuns.ts:42

list

list(resourceGroupName: string, registryName: string, options?: PipelineRunsListOptionalParams): PagedAsyncIterableIterator<PipelineRun>
Lists all the pipeline runs for the 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: PipelineRunsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PipelineRun>
- Defined in operationsInterfaces/pipelineRuns.ts:30

Interface PipelineRuns

Hierarchy

Index

Methods

Methods

beginCreate

Parameters

resourceGroupName: string

registryName: string

pipelineRunName: string

pipelineRunCreateParameters: PipelineRun

Optional options: PipelineRunsCreateOptionalParams

Returns Promise<PollerLike<PollOperationState<PipelineRun>, PipelineRun>>

beginCreateAndWait

Parameters

resourceGroupName: string

registryName: string

pipelineRunName: string

pipelineRunCreateParameters: PipelineRun

Optional options: PipelineRunsCreateOptionalParams

Returns Promise<PipelineRun>

beginDelete

Parameters

resourceGroupName: string

registryName: string

pipelineRunName: string

Optional options: PipelineRunsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

registryName: string

pipelineRunName: string

Optional options: PipelineRunsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

registryName: string

pipelineRunName: string

Optional options: PipelineRunsGetOptionalParams

Returns Promise<PipelineRun>

list

Parameters

resourceGroupName: string

registryName: string

Optional options: PipelineRunsListOptionalParams

Returns PagedAsyncIterableIterator<PipelineRun>

Settings

Member Visibility

Theme

`Optional` options: PipelineRunsCreateOptionalParams

`Optional` options: PipelineRunsCreateOptionalParams

`Optional` options: PipelineRunsDeleteOptionalParams

`Optional` options: PipelineRunsDeleteOptionalParams

`Optional` options: PipelineRunsGetOptionalParams

`Optional` options: PipelineRunsListOptionalParams