Package version:

Interface FileRenameOptions

Options to configure the ShareFileClient.rename operation.

interface FileRenameOptions {
    abortSignal?: any;
    contentType?: string;
    copyFileSmbInfo?: CopyFileSmbInfo;
    destinationLeaseAccessConditions?: LeaseAccessConditions;
    filePermission?: string;
    filePermissionFormat?: FilePermissionFormat;
    filePermissionKey?: string;
    ignoreReadOnly?: boolean;
    metadata?: Metadata;
    replaceIfExists?: boolean;
    sourceLeaseAccessConditions?: LeaseAccessConditions;
    timeoutInSeconds?: number;
    tracingOptions?: any;
}

Hierarchy (view full)

Properties

abortSignal? contentType? copyFileSmbInfo? destinationLeaseAccessConditions? filePermission? filePermissionFormat? filePermissionKey? ignoreReadOnly? metadata? replaceIfExists? sourceLeaseAccessConditions? timeoutInSeconds? 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.

OptionalcontentType

contentType?: string

Optional. Content type to set on the File.

OptionalcopyFileSmbInfo

copyFileSmbInfo?: CopyFileSmbInfo

Optional. Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key.

OptionaldestinationLeaseAccessConditions

destinationLeaseAccessConditions?: LeaseAccessConditions

Lease access condition for destination file. Required if the destination file has an active infinite lease.

OptionalfilePermission

filePermission?: string

Optional. If specified the permission (security descriptor) shall be set for the directory/file.

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

Optional. Key of the permission to be set for the directory/file. Note: Only one of the filePermission or filePermissionKey should be specified.

OptionalignoreReadOnly

ignoreReadOnly?: boolean

Optional. A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail.

Optionalmetadata

metadata?: Metadata

A name-value pair to associate with a file storage object.

OptionalreplaceIfExists

replaceIfExists?: boolean

Optional. A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the destination file. If not provided or if false and the destination file does exist, the request will not overwrite the destination file. If provided and the destination file doesn’t exist, the rename will succeed. Note: This value does not override the x-ms-file-copy-ignore-read-only header value.

OptionalsourceLeaseAccessConditions

sourceLeaseAccessConditions?: LeaseAccessConditions

Lease access condition for source file. Required if the source file has an active infinite lease.

OptionaltimeoutInSeconds

timeoutInSeconds?: number

Optional. The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.

OptionaltracingOptions

tracingOptions?: any

Settings

Member Visibility