FileRenameOptions interface

套件:

@azure/storage-file-share

設定 重新命名 作業的選項。

Extends

CommonOptions

屬性

abortSignal	AbortSignalLike 介面的實作，以發出取消作業的要求。 例如，使用 @azure/abort-controller 來建立 AbortSignal。
contentType	自選。 在 [檔案] 上設定的內容類型。
copyFileSmbInfo	自選。 指定從來源檔案複製檔案安全性描述元的選項，或使用 x-ms-file-permission 或 x-ms-file-permission-key 標頭值所定義的值加以設定。
destinationLeaseAccessConditions	目的地檔案的租用存取條件。 如果目的地檔案具有作用中的無限租用，則為必要專案。
filePermission	自選。 如果指定許可權（安全性描述元）應針對目錄/檔案設定。
filePermissionFormat	自選。 適用於 2023-06-01 版和更新版本。 指定傳回許可權的格式。 可接受的值為 SDDL 或二進位值。 如果 x-ms-file-permission-format 未指定或明確設定為 SDDL，則會以 SDDL 格式傳回許可權。 如果 x-ms-file-permission-format 明確設定為二進位檔，許可權會以base64字串的形式傳回，代表許可權的二進位編碼
filePermissionKey	自選。 要為目錄/檔案設定之許可權的索引鍵。 注意：應該只指定其中一個 filePermission 或 filePermissionKey。
ignoreReadOnly	自選。 布爾值，指定是否應該遵守預先存在的目的地檔案上的 ReadOnly 屬性。 如果為 true，則重新命名將會成功，否則目的地上已設定 ReadOnly 屬性的上一個檔案會導致重新命名失敗。
metadata	要與檔案記憶體物件建立關聯的名稱/值組。
replaceIfExists	自選。 如果目的地檔案已經存在，則為布爾值，不論此要求是否會覆寫檔案。 如果為 true，則重新命名將會成功，並會覆寫目的地檔案。 如果未提供，或如果 false 且目的地檔案存在，要求將不會覆寫目的地檔案。 如果提供且目的地檔案不存在，重新命名將會成功。 注意：此值不會覆寫 x-ms-file-copy-ignore-read-only 標頭值。
sourceLeaseAccessConditions	來源檔案的租用存取條件。 如果來源檔案具有作用中的無限租用，則為必要專案。
timeoutInSeconds	自選。 timeout 參數是以秒為單位來表示。 如需詳細資訊，請參閱 設定檔案服務作業的逾時。

繼承的屬性

tracingOptions

屬性詳細資料

abortSignal

AbortSignalLike 介面的實作，以發出取消作業的要求。 例如，使用 @azure/abort-controller 來建立 AbortSignal。

abortSignal?: AbortSignalLike

屬性值

AbortSignalLike

contentType

自選。 在 [檔案] 上設定的內容類型。

contentType?: string

屬性值

string

copyFileSmbInfo

自選。 指定從來源檔案複製檔案安全性描述元的選項，或使用 x-ms-file-permission 或 x-ms-file-permission-key 標頭值所定義的值加以設定。

copyFileSmbInfo?: CopyFileSmbInfo

屬性值

CopyFileSmbInfo

destinationLeaseAccessConditions

目的地檔案的租用存取條件。 如果目的地檔案具有作用中的無限租用，則為必要專案。

destinationLeaseAccessConditions?: LeaseAccessConditions

屬性值

LeaseAccessConditions

filePermission

自選。 如果指定許可權（安全性描述元）應針對目錄/檔案設定。

filePermission?: string

屬性值

string

filePermissionFormat

自選。 適用於 2023-06-01 版和更新版本。 指定傳回許可權的格式。 可接受的值為 SDDL 或二進位值。 如果 x-ms-file-permission-format 未指定或明確設定為 SDDL，則會以 SDDL 格式傳回許可權。 如果 x-ms-file-permission-format 明確設定為二進位檔，許可權會以base64字串的形式傳回，代表許可權的二進位編碼

filePermissionFormat?: FilePermissionFormat

屬性值

FilePermissionFormat

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

自選。 timeout 參數是以秒為單位來表示。 如需詳細資訊，請參閱 設定檔案服務作業的逾時。

timeoutInSeconds?: number

屬性值

number

繼承的屬性詳細資料

tracingOptions

tracingOptions?: OperationTracingOptions

屬性值

OperationTracingOptions

繼承自CommonOptions.tracingOptions