Share via

FileStartCopyHeaders interface

  • Reference
Package:
@azure/storage-file

Defines headers for StartCopy operation.

Properties

copyId

String identifier for this copy operation. Use with Get File or Get File Properties to check the status of this copy operation, or pass to Abort Copy File to abort a pending copy.
copyStatus

State of the copy operation identified by x-ms-copy-id. Possible values include: 'pending', 'success', 'aborted', 'failed'
date

A UTC date/time value generated by the service that indicates the time at which the response was initiated.
errorCode
eTag

If the copy is completed, contains the ETag of the destination file. If the copy is not complete, contains the ETag of the empty file created at the start of the copy.
lastModified

Returns the date/time that the copy operation to the destination file completed.
requestId

This header uniquely identifies the request that was made and can be used for troubleshooting the request.
version

Indicates the version of the File service used to execute the request.

Property Details

copyId

String identifier for this copy operation. Use with Get File or Get File Properties to check the status of this copy operation, or pass to Abort Copy File to abort a pending copy.

copyId?: string

Property Value

string

copyStatus

State of the copy operation identified by x-ms-copy-id. Possible values include: 'pending', 'success', 'aborted', 'failed'

copyStatus?: CopyStatusType

Property Value

CopyStatusType

date

A UTC date/time value generated by the service that indicates the time at which the response was initiated.

date?: Date

Property Value

Date

errorCode 

errorCode?: string

Property Value

string

eTag

If the copy is completed, contains the ETag of the destination file. If the copy is not complete, contains the ETag of the empty file created at the start of the copy.

eTag?: string

Property Value

string

lastModified

Returns the date/time that the copy operation to the destination file completed.

lastModified?: Date

Property Value

Date

requestId

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

requestId?: string

Property Value

string

version

Indicates the version of the File service used to execute the request.

version?: string

Property Value

string