ShareFileClient.Rename 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.
Renames a file. This API does not support renaming a file from one share to another, or between storage accounts.
public virtual Azure.Response<Azure.Storage.Files.Shares.ShareFileClient> Rename (string destinationPath, Azure.Storage.Files.Shares.Models.ShareFileRenameOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member Rename : string * Azure.Storage.Files.Shares.Models.ShareFileRenameOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.Shares.ShareFileClient>
override this.Rename : string * Azure.Storage.Files.Shares.Models.ShareFileRenameOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.Shares.ShareFileClient>
Public Overridable Function Rename (destinationPath As String, Optional options As ShareFileRenameOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ShareFileClient)
Parameters
- destinationPath
- String
The destination path to rename the file to.
- options
- ShareFileRenameOptions
Optional parameters.
- cancellationToken
- CancellationToken
Optional CancellationToken to propagate notifications that the operation should be cancelled.
Returns
A Response<T> pointed at the newly renamed File.
Remarks
A RequestFailedException will be thrown if a failure occurs.