PipelineClient.StartRenamePipeline(String, ArtifactRenameRequest, CancellationToken) Method

Definition

Renames a pipeline.

public virtual Azure.Analytics.Synapse.Artifacts.PipelineRenamePipelineOperation StartRenamePipeline (string pipelineName, Azure.Analytics.Synapse.Artifacts.Models.ArtifactRenameRequest request, System.Threading.CancellationToken cancellationToken = default);
abstract member StartRenamePipeline : string * Azure.Analytics.Synapse.Artifacts.Models.ArtifactRenameRequest * System.Threading.CancellationToken -> Azure.Analytics.Synapse.Artifacts.PipelineRenamePipelineOperation
override this.StartRenamePipeline : string * Azure.Analytics.Synapse.Artifacts.Models.ArtifactRenameRequest * System.Threading.CancellationToken -> Azure.Analytics.Synapse.Artifacts.PipelineRenamePipelineOperation
Public Overridable Function StartRenamePipeline (pipelineName As String, request As ArtifactRenameRequest, Optional cancellationToken As CancellationToken = Nothing) As PipelineRenamePipelineOperation

Parameters

pipelineName
System.String

The pipeline name.

request
ArtifactRenameRequest

proposed new name.

cancellationToken
System.Threading.CancellationToken

The cancellation token to use.

Returns

PipelineRenamePipelineOperation

Exceptions

System.ArgumentNullException

pipelineName or request is null.

Applies to