Package version:

Interface FileStartCopyOptions

Options to configure the ShareFileClient.startCopyFromURL operation.

interface FileStartCopyOptions {
    abortSignal?: any;
    copyFileSmbInfo?: CopyFileSmbInfo;
    fileModeCopyMode?: ModeCopyMode;
    fileOwnerCopyMode?: OwnerCopyMode;
    filePermission?: string;
    filePermissionFormat?: FilePermissionFormat;
    filePermissionKey?: string;
    leaseAccessConditions?: LeaseAccessConditions;
    metadata?: Metadata;
    posixProperties?: FilePosixProperties;
    tracingOptions?: any;
}

Hierarchy (view full)

Properties

abortSignal? copyFileSmbInfo? fileModeCopyMode? fileOwnerCopyMode? filePermission? filePermissionFormat? filePermissionKey? leaseAccessConditions? metadata? posixProperties? tracingOptions?

Properties

OptionalabortSignal

abortSignal?: any

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.

OptionalcopyFileSmbInfo

copyFileSmbInfo?: CopyFileSmbInfo

SMB info.

OptionalfileModeCopyMode

fileModeCopyMode?: ModeCopyMode

Optional, only applicable to NFS Files. Applicable only when the copy source is a File. Determines the copy behavior of the mode bits of the file. source: The mode on the destination file is copied from the source file. override: The mode on the destination file is determined via the x-ms-mode header.

OptionalfileOwnerCopyMode

fileOwnerCopyMode?: OwnerCopyMode

Optional, only applicable to NFS Files. Determines the copy behavior of the owner user identifier (UID) and group identifier (GID) of the file. source: The owner user identifier (UID) and group identifier (GID) on the destination file is copied from the source file. override: The owner user identifier (UID) and group identifier (GID) on the destination file is determined via the x-ms-owner and x-ms-group headers.

OptionalfilePermission

filePermission?: 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.

OptionalfilePermissionFormat

filePermissionFormat?: FilePermissionFormat

Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission

OptionalfilePermissionKey

filePermissionKey?: 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.

OptionalleaseAccessConditions

leaseAccessConditions?: LeaseAccessConditions

Lease access conditions.

Optionalmetadata

metadata?: Metadata

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

OptionalposixProperties

posixProperties?: FilePosixProperties

Optional properties to set on NFS files. Note that this property is only applicable to files created in NFS shares.

OptionaltracingOptions

tracingOptions?: any

Settings

Member Visibility