Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FileStartCopyHeaders

Package version

Defines headers for StartCopy operation.

Hierarchy

  • FileStartCopyHeaders

Index

Properties

Optional copyId

copyId: undefined | string

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.

Optional copyStatus

copyStatus: CopyStatusType

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

Optional date

date: Date

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

Optional errorCode

errorCode: undefined | string

Optional etag

etag: undefined | string

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.

Optional lastModified

lastModified: Date

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

Optional requestId

requestId: undefined | string

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

Optional version

version: undefined | string

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

Generated using TypeDoc