Package version:

Interface PipelineOperations

Interface representing a PipelineOperations.

Hierarchy

PipelineOperations

Index

Methods

beginCreateOrUpdatePipeline beginCreateOrUpdatePipelineAndWait beginDeletePipeline beginDeletePipelineAndWait beginRenamePipeline beginRenamePipelineAndWait createPipelineRun getPipeline listPipelinesByWorkspace

Methods

beginCreateOrUpdatePipeline

beginCreateOrUpdatePipeline(pipelineName: string, pipeline: PipelineResource, options?: PipelineCreateOrUpdatePipelineOptionalParams): Promise<PollerLike<PollOperationState<PipelineResource>, PipelineResource>>
Creates or updates a pipeline.
Parameters
- pipelineName: string
  
  The pipeline name.
- pipeline: PipelineResource
  
  Pipeline resource definition.
- Optional options: PipelineCreateOrUpdatePipelineOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<PipelineResource>, PipelineResource>>
- Defined in operationsInterfaces/pipelineOperations.ts:41

beginCreateOrUpdatePipelineAndWait

beginCreateOrUpdatePipelineAndWait(pipelineName: string, pipeline: PipelineResource, options?: PipelineCreateOrUpdatePipelineOptionalParams): Promise<PipelineResource>
Creates or updates a pipeline.
Parameters
- pipelineName: string
  
  The pipeline name.
- pipeline: PipelineResource
  
  Pipeline resource definition.
- Optional options: PipelineCreateOrUpdatePipelineOptionalParams
  
  The options parameters.
Returns Promise<PipelineResource>
- Defined in operationsInterfaces/pipelineOperations.ts:57

beginDeletePipeline

beginDeletePipeline(pipelineName: string, options?: PipelineDeletePipelineOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Deletes a pipeline.
Parameters
- pipelineName: string
  
  The pipeline name.
- Optional options: PipelineDeletePipelineOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/pipelineOperations.ts:76

beginDeletePipelineAndWait

beginDeletePipelineAndWait(pipelineName: string, options?: PipelineDeletePipelineOptionalParams): Promise<void>
Deletes a pipeline.
Parameters
- pipelineName: string
  
  The pipeline name.
- Optional options: PipelineDeletePipelineOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/pipelineOperations.ts:85

beginRenamePipeline

beginRenamePipeline(pipelineName: string, request: ArtifactRenameRequest, options?: PipelineRenamePipelineOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Renames a pipeline.
Parameters
- pipelineName: string
  
  The pipeline name.
- request: ArtifactRenameRequest
  
  proposed new name.
- Optional options: PipelineRenamePipelineOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/pipelineOperations.ts:95

beginRenamePipelineAndWait

beginRenamePipelineAndWait(pipelineName: string, request: ArtifactRenameRequest, options?: PipelineRenamePipelineOptionalParams): Promise<void>
Renames a pipeline.
Parameters
- pipelineName: string
  
  The pipeline name.
- request: ArtifactRenameRequest
  
  proposed new name.
- Optional options: PipelineRenamePipelineOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/pipelineOperations.ts:106

createPipelineRun

createPipelineRun(pipelineName: string, options?: PipelineCreatePipelineRunOptionalParams): Promise<CreateRunResponse>
Creates a run of a pipeline.
Parameters
- pipelineName: string
  
  The pipeline name.
- Optional options: PipelineCreatePipelineRunOptionalParams
  
  The options parameters.
Returns Promise<CreateRunResponse>
- Defined in operationsInterfaces/pipelineOperations.ts:116

getPipeline

getPipeline(pipelineName: string, options?: PipelineGetPipelineOptionalParams): Promise<PipelineResource>
Gets a pipeline.
Parameters
- pipelineName: string
  
  The pipeline name.
- Optional options: PipelineGetPipelineOptionalParams
  
  The options parameters.
Returns Promise<PipelineResource>
- Defined in operationsInterfaces/pipelineOperations.ts:67

listPipelinesByWorkspace

listPipelinesByWorkspace(options?: PipelineGetPipelinesByWorkspaceOptionalParams): PagedAsyncIterableIterator<PipelineResource>
Lists pipelines.
Parameters
- Optional options: PipelineGetPipelinesByWorkspaceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PipelineResource>
- Defined in operationsInterfaces/pipelineOperations.ts:32

Interface PipelineOperations

Hierarchy

Index

Methods

Methods

beginCreateOrUpdatePipeline

Parameters

pipelineName: string

pipeline: PipelineResource

Optional options: PipelineCreateOrUpdatePipelineOptionalParams

Returns Promise<PollerLike<PollOperationState<PipelineResource>, PipelineResource>>

beginCreateOrUpdatePipelineAndWait

Parameters

pipelineName: string

pipeline: PipelineResource

Optional options: PipelineCreateOrUpdatePipelineOptionalParams

Returns Promise<PipelineResource>

beginDeletePipeline

Parameters

pipelineName: string

Optional options: PipelineDeletePipelineOptionalParams

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

beginDeletePipelineAndWait

Parameters

pipelineName: string

Optional options: PipelineDeletePipelineOptionalParams

Returns Promise<void>

beginRenamePipeline

Parameters

pipelineName: string

request: ArtifactRenameRequest

Optional options: PipelineRenamePipelineOptionalParams

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

beginRenamePipelineAndWait

Parameters

pipelineName: string

request: ArtifactRenameRequest

Optional options: PipelineRenamePipelineOptionalParams

Returns Promise<void>

createPipelineRun

Parameters

pipelineName: string

Optional options: PipelineCreatePipelineRunOptionalParams

Returns Promise<CreateRunResponse>

getPipeline

Parameters

pipelineName: string

Optional options: PipelineGetPipelineOptionalParams

Returns Promise<PipelineResource>

listPipelinesByWorkspace

Parameters

Optional options: PipelineGetPipelinesByWorkspaceOptionalParams

Returns PagedAsyncIterableIterator<PipelineResource>

Settings

Member Visibility

Theme

`Optional` options: PipelineCreateOrUpdatePipelineOptionalParams

`Optional` options: PipelineCreateOrUpdatePipelineOptionalParams

`Optional` options: PipelineDeletePipelineOptionalParams

`Optional` options: PipelineDeletePipelineOptionalParams

`Optional` options: PipelineRenamePipelineOptionalParams

`Optional` options: PipelineRenamePipelineOptionalParams

`Optional` options: PipelineCreatePipelineRunOptionalParams

`Optional` options: PipelineGetPipelineOptionalParams

`Optional` options: PipelineGetPipelinesByWorkspaceOptionalParams