DirectoryRenameOptions interface

Csomag:

@azure/storage-file-share

A átnevezési művelet konfigurálására vonatkozó beállítások.

Extends

CommonOptions

Tulajdonságok

abortSignal	A AbortSignalLike felület implementálása, amely jelzi a művelet megszakítására irányuló kérést. Például a @azure/megszakításvezérlő használatával hozzon létre egy AbortSignal.
copyFileSmbInfo	Optional. Megadja a fájlbiztonsági leíró forrásfájlból való másolásának vagy beállításának lehetőségét az x-ms-file-permission vagy az x-ms-file-permission-key fejlécértéke által meghatározott érték használatával.
destinationLeaseAccessConditions	A célfájl hozzáférési feltételének bérlete. Kötelező, ha a célfájl aktív végtelen bérletet kapott.
filePermission	Optional. Ha meg van adva, az engedélyt (biztonsági leírót) be kell állítani a könyvtárhoz/fájlhoz.
filePermissionFormat	Optional. A 2023-06-01-es és újabb verziókhoz érhető el. Azt a formátumot adja meg, amelyben az engedély vissza lesz adva. Az elfogadható értékek az SDDL vagy a bináris értékek. Ha az x-ms-file-permission-format nem meghatározott vagy explicit módon SDDL-ra van állítva, az engedély SDDL formátumban lesz visszaadva. Ha az x-ms-file-permission-format explicit módon binárisra van állítva, a rendszer az engedélyt base64 sztringként adja vissza, amely az engedély bináris kódolását jelöli
filePermissionKey	Optional. A címtárhoz/fájlhoz beállítandó engedély kulcsa. Megjegyzés: Csak a filePermission vagy a filePermissionKey egyikét kell megadni.
ignoreReadOnly	Optional. Logikai érték, amely meghatározza, hogy a ReadOnly attribútumot tiszteletben kell-e tartani egy már létező célfájlon. Ha igaz, az átnevezés sikeres lesz, ellenkező esetben a ReadOnly attribútumkészlettel rendelkező célhelyen lévő korábbi fájl az átnevezés sikertelenségét okozza.
metadata	Optional. Egy fájltároló objektumhoz társítandó név-érték pár.
replaceIfExists	Optional. Logikai érték arra az esetre, ha a célfájl már létezik, akkor a kérés felülírja-e a fájlt. Ha igaz, az átnevezés sikeres lesz, és felülírja a célfájlt. Ha nincs megadva, vagy hamis, és a célfájl létezik, a kérés nem írja felül a célfájlt. Ha meg van adva, és a célfájl nem létezik, az átnevezés sikeres lesz. Megjegyzés: Ez az érték nem bírálja felül az x-ms-file-copy-ignore-read-only fejlécértéket.
sourceLeaseAccessConditions	A forrásfájl hozzáférési feltételének bérlete. Akkor szükséges, ha a forrásfájl aktív végtelen bérletet használ.
timeoutInSeconds	Optional. Az időtúllépési paraméter másodpercben van kifejezve. További információ: Időtúllépések beállítása a fájlszolgáltatás-műveletekhez.

Örökölt tulajdonságok

tracingOptions

Tulajdonság adatai

abortSignal

A AbortSignalLike felület implementálása, amely jelzi a művelet megszakítására irányuló kérést. Például a @azure/megszakításvezérlő használatával hozzon létre egy AbortSignal.

abortSignal?: AbortSignalLike

Tulajdonság értéke

AbortSignalLike

copyFileSmbInfo

Optional. Megadja a fájlbiztonsági leíró forrásfájlból való másolásának vagy beállításának lehetőségét az x-ms-file-permission vagy az x-ms-file-permission-key fejlécértéke által meghatározott érték használatával.

copyFileSmbInfo?: CopyFileSmbInfo

Tulajdonság értéke

CopyFileSmbInfo

destinationLeaseAccessConditions

A célfájl hozzáférési feltételének bérlete. Kötelező, ha a célfájl aktív végtelen bérletet kapott.

destinationLeaseAccessConditions?: LeaseAccessConditions

Tulajdonság értéke

LeaseAccessConditions

filePermission

Optional. Ha meg van adva, az engedélyt (biztonsági leírót) be kell állítani a könyvtárhoz/fájlhoz.

filePermission?: string

Tulajdonság értéke

string

filePermissionFormat

Optional. A 2023-06-01-es és újabb verziókhoz érhető el. Azt a formátumot adja meg, amelyben az engedély vissza lesz adva. Az elfogadható értékek az SDDL vagy a bináris értékek. Ha az x-ms-file-permission-format nem meghatározott vagy explicit módon SDDL-ra van állítva, az engedély SDDL formátumban lesz visszaadva. Ha az x-ms-file-permission-format explicit módon binárisra van állítva, a rendszer az engedélyt base64 sztringként adja vissza, amely az engedély bináris kódolását jelöli

filePermissionFormat?: FilePermissionFormat

Tulajdonság értéke

FilePermissionFormat

filePermissionKey

Optional. A címtárhoz/fájlhoz beállítandó engedély kulcsa. Megjegyzés: Csak a filePermission vagy a filePermissionKey egyikét kell megadni.

filePermissionKey?: string

Tulajdonság értéke

string

ignoreReadOnly

Optional. Logikai érték, amely meghatározza, hogy a ReadOnly attribútumot tiszteletben kell-e tartani egy már létező célfájlon. Ha igaz, az átnevezés sikeres lesz, ellenkező esetben a ReadOnly attribútumkészlettel rendelkező célhelyen lévő korábbi fájl az átnevezés sikertelenségét okozza.

ignoreReadOnly?: boolean

Tulajdonság értéke

boolean

metadata

Optional. Egy fájltároló objektumhoz társítandó név-érték pár.

metadata?: Metadata

Tulajdonság értéke

Metadata

replaceIfExists

Optional. Logikai érték arra az esetre, ha a célfájl már létezik, akkor a kérés felülírja-e a fájlt. Ha igaz, az átnevezés sikeres lesz, és felülírja a célfájlt. Ha nincs megadva, vagy hamis, és a célfájl létezik, a kérés nem írja felül a célfájlt. Ha meg van adva, és a célfájl nem létezik, az átnevezés sikeres lesz. Megjegyzés: Ez az érték nem bírálja felül az x-ms-file-copy-ignore-read-only fejlécértéket.

replaceIfExists?: boolean

Tulajdonság értéke

boolean

sourceLeaseAccessConditions

A forrásfájl hozzáférési feltételének bérlete. Akkor szükséges, ha a forrásfájl aktív végtelen bérletet használ.

sourceLeaseAccessConditions?: LeaseAccessConditions

Tulajdonság értéke

LeaseAccessConditions

timeoutInSeconds

Optional. Az időtúllépési paraméter másodpercben van kifejezve. További információ: Időtúllépések beállítása a fájlszolgáltatás-műveletekhez.

timeoutInSeconds?: number

Tulajdonság értéke

number

Örökölt tulajdonság részletei

tracingOptions

tracingOptions?: OperationTracingOptions

Tulajdonság értéke

OperationTracingOptions

A CommonOptions.tracingOptionswebhelyről örökölt