ShareFileClient.RenameAsync Method

Reference

Definition

Namespace:: Azure.Storage.Files.Shares

Assembly:: Azure.Storage.Files.Shares.dll

Package:: Azure.Storage.Files.Shares v12.17.1

Package:: Azure.Storage.Files.Shares v12.18.0-beta.2

Source:: ShareFileClient.cs

Source:: ShareFileClient.cs

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 System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.ShareFileClient>> RenameAsync (string destinationPath, Azure.Storage.Files.Shares.Models.ShareFileRenameOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member RenameAsync : string * Azure.Storage.Files.Shares.Models.ShareFileRenameOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.ShareFileClient>>
override this.RenameAsync : string * Azure.Storage.Files.Shares.Models.ShareFileRenameOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.ShareFileClient>>

Public Overridable Function RenameAsync (destinationPath As String, Optional options As ShareFileRenameOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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

Task<Response<ShareFileClient>>

A Response<T> pointed at the newly renamed File.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to