NotebookClient.StartRenameNotebook Method

Definition

Renames a notebook.

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

Parameters

notebookName
String

The notebook name.

request
ArtifactRenameRequest

proposed new name.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

notebookName or request is null.

Applies to