PipelineClient.StartRenamePipelineAsync Method

Reference

Definition

Namespace:: Azure.Analytics.Synapse.Artifacts

Assembly:: Azure.Analytics.Synapse.Artifacts.dll

Package:: Azure.Analytics.Synapse.Artifacts v1.0.0-preview.19

Source:: PipelineClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Renames a pipeline.

public virtual System.Threading.Tasks.Task<Azure.Analytics.Synapse.Artifacts.PipelineRenamePipelineOperation> StartRenamePipelineAsync (string pipelineName, Azure.Analytics.Synapse.Artifacts.Models.ArtifactRenameRequest request, System.Threading.CancellationToken cancellationToken = default);

abstract member StartRenamePipelineAsync : string * Azure.Analytics.Synapse.Artifacts.Models.ArtifactRenameRequest * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Analytics.Synapse.Artifacts.PipelineRenamePipelineOperation>
override this.StartRenamePipelineAsync : string * Azure.Analytics.Synapse.Artifacts.Models.ArtifactRenameRequest * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Analytics.Synapse.Artifacts.PipelineRenamePipelineOperation>

Public Overridable Function StartRenamePipelineAsync (pipelineName As String, request As ArtifactRenameRequest, Optional cancellationToken As CancellationToken = Nothing) As Task(Of PipelineRenamePipelineOperation)

Parameters

pipelineName: String

The pipeline name.

request: ArtifactRenameRequest

proposed new name.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<PipelineRenamePipelineOperation>

Exceptions

ArgumentNullException

pipelineName or request is null.

Applies to