DataLakeFileClient.RenameAsync(String, String, DataLakeRequestConditions, DataLakeRequestConditions, CancellationToken) Method

Definition

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.DataLakeFileClient>> RenameAsync (string destinationPath, string destinationFileSystem = default, Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions sourceConditions = default, Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions destinationConditions = default, System.Threading.CancellationToken cancellationToken = default);
override this.RenameAsync : string * string * Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions * Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.DataLakeFileClient>>
Public Overridable Function RenameAsync (destinationPath As String, Optional destinationFileSystem As String = Nothing, Optional sourceConditions As DataLakeRequestConditions = Nothing, Optional destinationConditions As DataLakeRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DataLakeFileClient))

Parameters

destinationPath
System.String

The destination path to rename the path to.

destinationFileSystem
System.String

Optional destination file system. If null, path will be renamed within the current file system.

sourceConditions
DataLakeRequestConditions

Optional DataLakeRequestConditions to add conditions on the source on the creation of this file or directory.

destinationConditions
DataLakeRequestConditions

Optional DataLakeRequestConditions to add conditions on the creation of this file or directory.

cancellationToken
System.Threading.CancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Response<DataLakeFileClient>>

A Response<T> describing the newly created file.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to