ShareFileClient.StartCopyAsync 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.
Copies a blob or file to a destination file within the storage account.
For more information, see Copy File.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.ShareFileCopyInfo>> StartCopyAsync (Uri sourceUri, Azure.Storage.Files.Shares.Models.ShareFileCopyOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member StartCopyAsync : Uri * Azure.Storage.Files.Shares.Models.ShareFileCopyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.ShareFileCopyInfo>>
override this.StartCopyAsync : Uri * Azure.Storage.Files.Shares.Models.ShareFileCopyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.ShareFileCopyInfo>>
Public Overridable Function StartCopyAsync (sourceUri As Uri, Optional options As ShareFileCopyOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ShareFileCopyInfo))
Parameters
- sourceUri
- Uri
Required. Specifies the URL of the source file or blob.
- options
- ShareFileCopyOptions
Optional parameters.
- cancellationToken
- CancellationToken
Optional CancellationToken to propagate notifications that the operation should be cancelled.
Returns
A Response<T> describing the state of the file copy.
Remarks
A RequestFailedException will be thrown if a failure occurs.