Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FileStartCopyOptions

Package version

Options to configure the ShareFileClient.startCopyFromURL operation.

Hierarchy

Index

Properties

Optional abortSignal

abortSignal: AbortSignalLike

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.

Optional copyFileSmbInfo

copyFileSmbInfo: CopyFileSmbInfo

SMB info.

Optional filePermission

filePermission: undefined | string

If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is lesser than or equal to 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.

Optional filePermissionKey

filePermissionKey: undefined | string

Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.

Optional leaseAccessConditions

leaseAccessConditions: LeaseAccessConditions

Lease access conditions.

Optional metadata

metadata: Metadata

A collection of key-value string pair to associate with the file storage object.

Optional tracingOptions

tracingOptions: OperationTracingOptions

Generated using TypeDoc