DirectoryRenameOptions interface

Paket:

@azure/storage-file-share

Opsi untuk mengonfigurasi operasi ganti nama.

Memperluas

CommonOptions

Properti

abortSignal	Implementasi antarmuka AbortSignalLike untuk memberi sinyal permintaan untuk membatalkan operasi. Misalnya, gunakan @azure/abort-controller untuk membuat AbortSignal.
copyFileSmbInfo	Optional. Menentukan opsi untuk menyalin pendeskripsi keamanan file dari file sumber atau untuk mengaturnya menggunakan nilai yang ditentukan oleh nilai header x-ms-file-permission atau x-ms-file-permission-key.
destinationLeaseAccessConditions	Kondisi akses sewa untuk file tujuan. Diperlukan jika file tujuan memiliki sewa tak terbatas aktif.
filePermission	Optional. Jika ditentukan, izin (pendeskripsi keamanan) akan diatur untuk direktori/file.
filePermissionFormat	Optional. Tersedia untuk versi 2023-06-01 dan yang lebih baru. Menentukan format di mana izin dikembalikan. Nilai yang dapat diterima adalah SDDL atau biner. Jika x-ms-file-permission-format tidak ditentukan atau secara eksplisit diatur ke SDDL, izin dikembalikan dalam format SDDL. Jika x-ms-file-permission-format secara eksplisit diatur ke biner, izin dikembalikan sebagai string base64 yang mewakili pengodean biner izin
filePermissionKey	Optional. Kunci izin yang akan diatur untuk direktori/file. Catatan: Hanya salah satu filePermission atau filePermissionKey yang harus ditentukan.
ignoreReadOnly	Optional. Nilai boolean yang menentukan apakah atribut ReadOnly pada file tujuan yang sudah ada sebelumnya harus dihormati. Jika true, penggantian nama akan berhasil, jika tidak, file sebelumnya di tujuan dengan set atribut ReadOnly akan menyebabkan penggantian nama gagal.
metadata	Optional. Pasangan nama-nilai untuk dikaitkan dengan objek penyimpanan file.
replaceIfExists	Optional. Nilai boolean untuk jika file tujuan sudah ada, apakah permintaan ini akan menimpa file atau tidak. Jika true, penggantian nama akan berhasil dan akan menimpa file tujuan. Jika tidak disediakan atau jika salah dan file tujuan tidak ada, permintaan tidak akan menimpa file tujuan. Jika disediakan dan file tujuan tidak ada, penggantian nama akan berhasil. Catatan: Nilai ini tidak mengambil alih nilai header x-ms-file-copy-ignore-read-only.
sourceLeaseAccessConditions	Kondisi akses sewa untuk file sumber. Diperlukan jika file sumber memiliki sewa tak terbatas aktif.
timeoutInSeconds	Optional. Parameter batas waktu dinyatakan dalam detik. Untuk informasi selengkapnya, lihat Mengatur Batas Waktu untuk Operasi Layanan File.

Properti yang Diwariskan

tracingOptions

Detail Properti

abortSignal

Implementasi antarmuka AbortSignalLike untuk memberi sinyal permintaan untuk membatalkan operasi. Misalnya, gunakan @azure/abort-controller untuk membuat AbortSignal.

abortSignal?: AbortSignalLike

Nilai Properti

AbortSignalLike

copyFileSmbInfo

Optional. Menentukan opsi untuk menyalin pendeskripsi keamanan file dari file sumber atau untuk mengaturnya menggunakan nilai yang ditentukan oleh nilai header x-ms-file-permission atau x-ms-file-permission-key.

copyFileSmbInfo?: CopyFileSmbInfo

Nilai Properti

CopyFileSmbInfo

destinationLeaseAccessConditions

Kondisi akses sewa untuk file tujuan. Diperlukan jika file tujuan memiliki sewa tak terbatas aktif.

destinationLeaseAccessConditions?: LeaseAccessConditions

Nilai Properti

LeaseAccessConditions

filePermission

Optional. Jika ditentukan, izin (pendeskripsi keamanan) akan diatur untuk direktori/file.

filePermission?: string

Nilai Properti

string

filePermissionFormat

Optional. Tersedia untuk versi 2023-06-01 dan yang lebih baru. Menentukan format di mana izin dikembalikan. Nilai yang dapat diterima adalah SDDL atau biner. Jika x-ms-file-permission-format tidak ditentukan atau secara eksplisit diatur ke SDDL, izin dikembalikan dalam format SDDL. Jika x-ms-file-permission-format secara eksplisit diatur ke biner, izin dikembalikan sebagai string base64 yang mewakili pengodean biner izin

filePermissionFormat?: FilePermissionFormat

Nilai Properti

FilePermissionFormat

filePermissionKey

Optional. Kunci izin yang akan diatur untuk direktori/file. Catatan: Hanya salah satu filePermission atau filePermissionKey yang harus ditentukan.

filePermissionKey?: string

Nilai Properti

string

ignoreReadOnly

Optional. Nilai boolean yang menentukan apakah atribut ReadOnly pada file tujuan yang sudah ada sebelumnya harus dihormati. Jika true, penggantian nama akan berhasil, jika tidak, file sebelumnya di tujuan dengan set atribut ReadOnly akan menyebabkan penggantian nama gagal.

ignoreReadOnly?: boolean

Nilai Properti

boolean

metadata

Optional. Pasangan nama-nilai untuk dikaitkan dengan objek penyimpanan file.

metadata?: Metadata

Nilai Properti

Metadata

replaceIfExists

Optional. Nilai boolean untuk jika file tujuan sudah ada, apakah permintaan ini akan menimpa file atau tidak. Jika true, penggantian nama akan berhasil dan akan menimpa file tujuan. Jika tidak disediakan atau jika salah dan file tujuan tidak ada, permintaan tidak akan menimpa file tujuan. Jika disediakan dan file tujuan tidak ada, penggantian nama akan berhasil. Catatan: Nilai ini tidak mengambil alih nilai header x-ms-file-copy-ignore-read-only.

replaceIfExists?: boolean

Nilai Properti

boolean

sourceLeaseAccessConditions

Kondisi akses sewa untuk file sumber. Diperlukan jika file sumber memiliki sewa tak terbatas aktif.

sourceLeaseAccessConditions?: LeaseAccessConditions

Nilai Properti

LeaseAccessConditions

timeoutInSeconds

Optional. Parameter batas waktu dinyatakan dalam detik. Untuk informasi selengkapnya, lihat Mengatur Batas Waktu untuk Operasi Layanan File.

timeoutInSeconds?: number

Nilai Properti

number

Detail Properti yang Diwariskan

tracingOptions

tracingOptions?: OperationTracingOptions

Nilai Properti

OperationTracingOptions

Diwarisi dariCommonOptions.tracingOptions