DatasetClient.StartRenameDataset Method

Definition

Renames a dataset.

public virtual Azure.Analytics.Synapse.Artifacts.DatasetRenameDatasetOperation StartRenameDataset (string datasetName, Azure.Analytics.Synapse.Artifacts.Models.ArtifactRenameRequest request, System.Threading.CancellationToken cancellationToken = default);
abstract member StartRenameDataset : string * Azure.Analytics.Synapse.Artifacts.Models.ArtifactRenameRequest * System.Threading.CancellationToken -> Azure.Analytics.Synapse.Artifacts.DatasetRenameDatasetOperation
override this.StartRenameDataset : string * Azure.Analytics.Synapse.Artifacts.Models.ArtifactRenameRequest * System.Threading.CancellationToken -> Azure.Analytics.Synapse.Artifacts.DatasetRenameDatasetOperation
Public Overridable Function StartRenameDataset (datasetName As String, request As ArtifactRenameRequest, Optional cancellationToken As CancellationToken = Nothing) As 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