你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

DirectoryRenameOptions interface

包:

@azure/storage-file-share

用于配置操作的选项 rename(string, DirectoryRenameOptions) 。

Extends

CommonOptions

属性

abortSignal	接口的实现， AbortSignalLike 用于向取消操作的请求发出信号。 例如，使用 @azure/abort-controller 创建 AbortSignal。
copyFileSmbInfo	可选。 指定从源文件复制文件安全描述符或使用 x-ms-file-permission 或 x-ms-file-permission-key 标头值定义的值设置的选项。
destinationLeaseAccessConditions	目标文件的租约访问条件。 如果目标文件具有活动的无限租约，则为必需。
filePermission	可选。 如果指定了权限 (应为目录/文件设置安全描述符) 。
filePermissionKey	可选。 要为目录/文件设置的权限的键。 注意：应仅指定 filePermission 或 filePermissionKey 中的一个。
ignoreReadOnly	可选。 一个布尔值，指定是否应遵循预先存在的目标文件上的 ReadOnly 属性。 如果为 true，则重命名将成功，否则，目标中设置了 ReadOnly 属性的上一个文件将导致重命名失败。
metadata	可选。 要与文件存储对象关联的名称/值对。
replaceIfExists	可选。 如果目标文件已存在，则为 的布尔值，此请求是否会覆盖该文件。 如果为 true，则重命名将成功并覆盖目标文件。 如果未提供或 false 且目标文件确实存在，则请求不会覆盖目标文件。 如果已提供且目标文件不存在，则重命名将成功。 注意：此值不会替代 x-ms-file-copy-ignore-read-only 标头值。
sourceLeaseAccessConditions	源文件的租约访问条件。 如果源文件具有活动的无限租约，则是必需的。
timeoutInSeconds	可选。 超时参数以秒表示。 有关详细信息，请参阅 设置文件服务操作的超时。

继承属性

tracingOptions

属性详细信息

abortSignal

接口的实现， AbortSignalLike 用于向取消操作的请求发出信号。 例如，使用 @azure/abort-controller 创建 AbortSignal。

abortSignal?: AbortSignalLike

属性值

AbortSignalLike

copyFileSmbInfo

可选。 指定从源文件复制文件安全描述符或使用 x-ms-file-permission 或 x-ms-file-permission-key 标头值定义的值设置的选项。

copyFileSmbInfo?: CopyFileSmbInfo

属性值

CopyFileSmbInfo

destinationLeaseAccessConditions

目标文件的租约访问条件。 如果目标文件具有活动的无限租约，则为必需。

destinationLeaseAccessConditions?: LeaseAccessConditions

属性值

LeaseAccessConditions

filePermission

可选。 如果指定了权限 (应为目录/文件设置安全描述符) 。

filePermission?: string

属性值

string

filePermissionKey

可选。 要为目录/文件设置的权限的键。 注意：应仅指定 filePermission 或 filePermissionKey 中的一个。

filePermissionKey?: string

属性值

string

ignoreReadOnly

可选。 一个布尔值，指定是否应遵循预先存在的目标文件上的 ReadOnly 属性。 如果为 true，则重命名将成功，否则，目标中设置了 ReadOnly 属性的上一个文件将导致重命名失败。

ignoreReadOnly?: boolean

属性值

boolean

metadata

可选。 要与文件存储对象关联的名称/值对。

metadata?: Metadata

属性值

Metadata

replaceIfExists

可选。 如果目标文件已存在，则为 的布尔值，此请求是否会覆盖该文件。 如果为 true，则重命名将成功并覆盖目标文件。 如果未提供或 false 且目标文件确实存在，则请求不会覆盖目标文件。 如果已提供且目标文件不存在，则重命名将成功。 注意：此值不会替代 x-ms-file-copy-ignore-read-only 标头值。

replaceIfExists?: boolean

属性值

boolean

sourceLeaseAccessConditions

源文件的租约访问条件。 如果源文件具有活动的无限租约，则是必需的。

sourceLeaseAccessConditions?: LeaseAccessConditions

属性值

LeaseAccessConditions

timeoutInSeconds

可选。 超时参数以秒表示。 有关详细信息，请参阅 设置文件服务操作的超时。

timeoutInSeconds?: number

属性值

number

继承属性详细信息

tracingOptions

tracingOptions?: OperationTracingOptions

属性值

OperationTracingOptions

继承自CommonOptions.tracingOptions