DatasetClient.StartRenameDatasetAsync Method

Definition

Renames a dataset.

public virtual System.Threading.Tasks.Task<Azure.Analytics.Synapse.Artifacts.DatasetRenameDatasetOperation> StartRenameDatasetAsync (string datasetName, Azure.Analytics.Synapse.Artifacts.Models.ArtifactRenameRequest request, System.Threading.CancellationToken cancellationToken = default);
abstract member StartRenameDatasetAsync : string * Azure.Analytics.Synapse.Artifacts.Models.ArtifactRenameRequest * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Analytics.Synapse.Artifacts.DatasetRenameDatasetOperation>
override this.StartRenameDatasetAsync : string * Azure.Analytics.Synapse.Artifacts.Models.ArtifactRenameRequest * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Analytics.Synapse.Artifacts.DatasetRenameDatasetOperation>
Public Overridable Function StartRenameDatasetAsync (datasetName As String, request As ArtifactRenameRequest, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DatasetRenameDatasetOperation)

Parameters

datasetName
String

The dataset name.

request
ArtifactRenameRequest

proposed new name.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

datasetName or request is null.

Applies to