BlobBaseClient.StartCopyFromUri Method

Reference

Definition

Namespace:: Azure.Storage.Blobs.Specialized

Assembly:: Azure.Storage.Blobs.dll

Package:: Azure.Storage.Blobs v12.22.2

Package:: Azure.Storage.Blobs v12.23.0-beta.2

Source:: BlobBaseClient.cs

Source:: BlobBaseClient.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 StartCopyFromUri(Uri, BlobCopyFromUriOptions, CancellationToken) operation begins an asynchronous copy of the data from the source to this blob. You can check the Azure.Storage.Blobs.Models.BlobProperties.CopyStatus returned from the GetProperties(BlobRequestConditions, CancellationToken) to determine if the copy has completed.

For more information, see Copy Blob.

public virtual Azure.Storage.Blobs.Models.CopyFromUriOperation StartCopyFromUri (Uri source, Azure.Storage.Blobs.Models.BlobCopyFromUriOptions options, System.Threading.CancellationToken cancellationToken = default);

abstract member StartCopyFromUri : Uri * Azure.Storage.Blobs.Models.BlobCopyFromUriOptions * System.Threading.CancellationToken -> Azure.Storage.Blobs.Models.CopyFromUriOperation
override this.StartCopyFromUri : Uri * Azure.Storage.Blobs.Models.BlobCopyFromUriOptions * System.Threading.CancellationToken -> Azure.Storage.Blobs.Models.CopyFromUriOperation

Public Overridable Function StartCopyFromUri (source As Uri, options As BlobCopyFromUriOptions, Optional cancellationToken As CancellationToken = Nothing) As CopyFromUriOperation

Parameters

source: Uri

Specifies the Uri of the source blob. The value may be a Uri of up to 2 KB in length that specifies a blob. Source Blob Authentication

The source object may be a file in the Azure File service. If the source object is a file that is to be copied to a blob, then the source file must be authenticated using a shared access signature, whether it resides in the same account or in a different account.

options: BlobCopyFromUriOptions

Optional parameters. Note that CopySourceTagsMode is not applicable to this API.

cancellationToken: CancellationToken

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

Returns

CopyFromUriOperation

A CopyFromUriOperation describing the state of the copy operation.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to

Share via