DataLakeDirectoryClient.RenameAsync Method
Definition
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.
The RenameAsync(String, String, DataLakeRequestConditions, DataLakeRequestConditions, CancellationToken) operation renames a file or directory.
For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.DataLakeDirectoryClient>> 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.DataLakeDirectoryClient>>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 DataLakeDirectoryClient))Parameters
- destinationPath
- String
The destination path to rename the path to.
- destinationFileSystem
- 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
- CancellationToken
Optional CancellationToken to propagate notifications that the operation should be cancelled.
Returns
A Response<T> for the newly created directory.
Remarks
A RequestFailedException will be thrown if a failure occurs.
