FileRenameOptions interface

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

abortSignal?: AbortSignalLike

属性值

自选。 要设置在文件上的内容类型。

contentType?: string

属性值

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

copyFileSmbInfo?: CopyFileSmbInfo

属性值

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

destinationLeaseAccessConditions?: LeaseAccessConditions

属性值

自选。 如果指定了权限（安全描述符），则应为目录/文件设置权限。

filePermission?: string

属性值

自选。 适用于版本 2023-06-01 及更高版本。 指定返回权限的格式。 可接受的值为 SDDL 或二进制值。 如果 x-ms-file-permission-format 未指定或显式设置为 SDDL，则以 SDDL 格式返回该权限。 如果 x-ms-file-permission-format 显式设置为二进制格式，则权限将作为 base64 字符串返回，表示权限的二进制编码

filePermissionFormat?: FilePermissionFormat

属性值

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

filePermissionKey?: string

属性值

自选。 一个布尔值，该值指定是否应尊重预先存在的目标文件上的 ReadOnly 属性。 如果为 true，则重命名将成功，否则，目标上一个具有 ReadOnly 属性集的文件将导致重命名失败。

ignoreReadOnly?: boolean

属性值

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

metadata?: Metadata

属性值

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

replaceIfExists?: boolean

属性值

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

sourceLeaseAccessConditions?: LeaseAccessConditions

属性值

自选。 超时参数以秒为单位表示。 有关详细信息，请参阅 为文件服务作设置超时。

timeoutInSeconds?: number

属性值

tracingOptions?: OperationTracingOptions

属性值

继承自CommonOptions.tracingOptions