ShareFileClient.UploadAsync 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.

The UploadAsync(Stream, ShareFileUploadOptions, CancellationToken) operation writes options.Stream.Stream to a file.

For more information, see Put Range.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.ShareFileUploadInfo>> UploadAsync (System.IO.Stream stream, Azure.Storage.Files.Shares.Models.ShareFileUploadOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member UploadAsync : System.IO.Stream * Azure.Storage.Files.Shares.Models.ShareFileUploadOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.ShareFileUploadInfo>>
override this.UploadAsync : System.IO.Stream * Azure.Storage.Files.Shares.Models.ShareFileUploadOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.ShareFileUploadInfo>>

Public Overridable Function UploadAsync (stream As Stream, Optional options As ShareFileUploadOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ShareFileUploadInfo))

Parameters

stream: Stream

Content stream to upload.

options: ShareFileUploadOptions

Upload options.

cancellationToken: CancellationToken

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

Returns

Task<Response<ShareFileUploadInfo>>

A Response<T> describing the state of the file.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to