CloudFile.StartCopy Method

Definition

Namespace:

Microsoft.Azure.Storage.File

Assembly:

Microsoft.Azure.Storage.File.dll

Package:

Microsoft.Azure.Storage.File v11.2.3

Overloads

StartCopy(CloudFile, AccessCondition, AccessCondition, FileRequestOptions, OperationContext)	Begins an operation to start copying another file's contents, properties, and metadata to this file.
StartCopy(Uri, AccessCondition, AccessCondition, FileRequestOptions, OperationContext)	Begins an operation to start copying another Azure file or blob's contents, properties, and metadata to this Azure file.
StartCopy(CloudFile, AccessCondition, AccessCondition, FileCopyOptions, FileRequestOptions, OperationContext)	Begins an operation to start copying another file's contents, properties, and metadata to this file.
StartCopy(Uri, AccessCondition, AccessCondition, FileCopyOptions, FileRequestOptions, OperationContext)	Begins an operation to start copying another Azure file or blob's contents, properties, and metadata to this Azure file.

StartCopy(CloudFile, AccessCondition, AccessCondition, FileRequestOptions, OperationContext)

Begins an operation to start copying another file's contents, properties, and metadata to this file.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual string StartCopy (Microsoft.Azure.Storage.File.CloudFile source, Microsoft.Azure.Storage.AccessCondition sourceAccessCondition = default, Microsoft.Azure.Storage.AccessCondition destAccessCondition = default, Microsoft.Azure.Storage.File.FileRequestOptions options = default, Microsoft.Azure.Storage.OperationContext operationContext = default);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member StartCopy : Microsoft.Azure.Storage.File.CloudFile * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> string
override this.StartCopy : Microsoft.Azure.Storage.File.CloudFile * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> string

Public Overridable Function StartCopy (source As CloudFile, Optional sourceAccessCondition As AccessCondition = Nothing, Optional destAccessCondition As AccessCondition = Nothing, Optional options As FileRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing) As String

Parameters

source

CloudFile

A CloudFile object.

sourceAccessCondition

AccessCondition

An AccessCondition object that represents the access conditions for the source file. If null, no condition is used.

destAccessCondition

AccessCondition

An AccessCondition object that represents the access conditions for the destination file. If null, no condition is used.

options

FileRequestOptions

A FileRequestOptions object that specifies additional options for the request. If null, default options are applied to the request.

operationContext

OperationContext

An OperationContext object that represents the context for the current operation.

Returns

String

The copy ID associated with the copy operation.

Attributes

DoesServiceRequestAttribute

Remarks

This method fetches the file's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

StartCopy(Uri, AccessCondition, AccessCondition, FileRequestOptions, OperationContext)

Begins an operation to start copying another Azure file or blob's contents, properties, and metadata to this Azure file.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual string StartCopy (Uri source, Microsoft.Azure.Storage.AccessCondition sourceAccessCondition = default, Microsoft.Azure.Storage.AccessCondition destAccessCondition = default, Microsoft.Azure.Storage.File.FileRequestOptions options = default, Microsoft.Azure.Storage.OperationContext operationContext = default);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member StartCopy : Uri * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> string
override this.StartCopy : Uri * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> string

Public Overridable Function StartCopy (source As Uri, Optional sourceAccessCondition As AccessCondition = Nothing, Optional destAccessCondition As AccessCondition = Nothing, Optional options As FileRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing) As String

Parameters

source

Uri

The Uri of the source blob or file.

sourceAccessCondition

AccessCondition

An AccessCondition object that represents the access conditions for the source object. If null, no condition is used.

destAccessCondition

AccessCondition

An AccessCondition object that represents the access conditions for the destination file. If null, no condition is used.

options

FileRequestOptions

A FileRequestOptions object that specifies additional options for the request. If null, default options are applied to the request.

operationContext

OperationContext

An OperationContext object that represents the context for the current operation.

Returns

String

The copy ID associated with the copy operation.

Attributes

DoesServiceRequestAttribute

Remarks

This method fetches the file's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

StartCopy(CloudFile, AccessCondition, AccessCondition, FileCopyOptions, FileRequestOptions, OperationContext)

Begins an operation to start copying another file's contents, properties, and metadata to this file.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual string StartCopy (Microsoft.Azure.Storage.File.CloudFile source, Microsoft.Azure.Storage.AccessCondition sourceAccessCondition, Microsoft.Azure.Storage.AccessCondition destAccessCondition, Microsoft.Azure.Storage.File.FileCopyOptions copyOptions, Microsoft.Azure.Storage.File.FileRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member StartCopy : Microsoft.Azure.Storage.File.CloudFile * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileCopyOptions * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> string
override this.StartCopy : Microsoft.Azure.Storage.File.CloudFile * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileCopyOptions * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> string

Public Overridable Function StartCopy (source As CloudFile, sourceAccessCondition As AccessCondition, destAccessCondition As AccessCondition, copyOptions As FileCopyOptions, options As FileRequestOptions, operationContext As OperationContext) As String

Parameters

source

CloudFile

A CloudFile object.

sourceAccessCondition

AccessCondition

An AccessCondition object that represents the access conditions for the source file. If null, no condition is used.

destAccessCondition

AccessCondition

An AccessCondition object that represents the access conditions for the destination file. If null, no condition is used.

copyOptions

FileCopyOptions

An FileCopyOptions object that represents the options for the copying. If null, default options are applied.

options

FileRequestOptions

A FileRequestOptions object that specifies additional options for the request. If null, default options are applied to the request.

operationContext

OperationContext

An OperationContext object that represents the context for the current operation.

Returns

String

The copy ID associated with the copy operation.

Attributes

DoesServiceRequestAttribute

Remarks

This method fetches the file's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

StartCopy(Uri, AccessCondition, AccessCondition, FileCopyOptions, FileRequestOptions, OperationContext)

Begins an operation to start copying another Azure file or blob's contents, properties, and metadata to this Azure file.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual string StartCopy (Uri source, Microsoft.Azure.Storage.AccessCondition sourceAccessCondition, Microsoft.Azure.Storage.AccessCondition destAccessCondition, Microsoft.Azure.Storage.File.FileCopyOptions copyOptions, Microsoft.Azure.Storage.File.FileRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member StartCopy : Uri * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileCopyOptions * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> string
override this.StartCopy : Uri * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileCopyOptions * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> string

Public Overridable Function StartCopy (source As Uri, sourceAccessCondition As AccessCondition, destAccessCondition As AccessCondition, copyOptions As FileCopyOptions, options As FileRequestOptions, operationContext As OperationContext) As String

Parameters

source

Uri

The Uri of the source blob or file.

sourceAccessCondition

AccessCondition

An AccessCondition object that represents the access conditions for the source object. If null, no condition is used.

destAccessCondition

AccessCondition

An AccessCondition object that represents the access conditions for the destination file. If null, no condition is used.

copyOptions

FileCopyOptions

An FileCopyOptions object that represents the options for the copying. If null, default options are applied.

options

FileRequestOptions

A FileRequestOptions object that specifies additional options for the request. If null, default options are applied to the request.

operationContext

OperationContext

An OperationContext object that represents the context for the current operation.

Returns

String

The copy ID associated with the copy operation.

Attributes

DoesServiceRequestAttribute

Remarks

This method fetches the file's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.