FileRenameOptions interface

Paket:

@azure/storage-file-share

Alternativ för att konfigurera namnbytesåtgärden .

Extends

CommonOptions

Egenskaper

abortSignal	En implementering av AbortSignalLike gränssnittet för att signalera begäran om att avbryta åtgärden. Använd till exempel @azure/abort-controller för att skapa en AbortSignal.
contentType	Valfritt. Innehållstyp som ska anges för filen.
copyFileSmbInfo	Valfritt. Anger alternativet att kopiera filsäkerhetsbeskrivningen från källfilen eller ange den med hjälp av värdet som definieras av huvudvärdet för x-ms-file-permission eller x-ms-file-permission-key.
destinationLeaseAccessConditions	Villkor för låneåtkomst för målfilen. Krävs om målfilen har ett aktivt oändligt lån.
filePermission	Valfritt. Om detta anges ska behörigheten (säkerhetsbeskrivning) anges för katalogen/filen.
filePermissionKey	Valfritt. Nyckeln för behörigheten som ska anges för katalogen/filen. Obs! Endast en av filePermission eller filePermissionKey ska anges.
ignoreReadOnly	Valfritt. Ett booleskt värde som anger om attributet ReadOnly i en befintlig målfil ska respekteras. Om det är sant kommer namnbytet att lyckas, annars kommer en tidigare fil på målet med ReadOnly-attributuppsättningen att orsaka att namnbytet misslyckas.
metadata	Ett namn/värde-par som ska associeras med ett fillagringsobjekt.
replaceIfExists	Valfritt. Ett booleskt värde för om målfilen redan finns, oavsett om den här begäran kommer att skriva över filen eller inte. Om det är sant kommer namnbytet att lyckas och kommer att skriva över målfilen. Om det inte anges eller om det finns falskt och målfilen finns, kommer begäran inte att skriva över målfilen. Om det anges och målfilen inte finns lyckas namnbytet. Obs! Det här värdet åsidosätter inte huvudvärdet x-ms-file-copy-ignore-read-only.
sourceLeaseAccessConditions	Villkor för låneåtkomst för källfilen. Krävs om källfilen har ett aktivt oändligt lån.
timeoutInSeconds	Valfritt. Timeout-parametern uttrycks i sekunder. Mer information finns i Ange tidsgränser för filtjänståtgärder.

Ärvda egenskaper

tracingOptions

Egenskapsinformation

abortSignal

En implementering av AbortSignalLike gränssnittet för att signalera begäran om att avbryta åtgärden. Använd till exempel @azure/abort-controller för att skapa en AbortSignal.

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

contentType

Valfritt. Innehållstyp som ska anges för filen.

contentType?: string

Egenskapsvärde

string

copyFileSmbInfo

Valfritt. Anger alternativet att kopiera filsäkerhetsbeskrivningen från källfilen eller ange den med hjälp av värdet som definieras av huvudvärdet för x-ms-file-permission eller x-ms-file-permission-key.

copyFileSmbInfo?: CopyFileSmbInfo

Egenskapsvärde

CopyFileSmbInfo

destinationLeaseAccessConditions

Villkor för låneåtkomst för målfilen. Krävs om målfilen har ett aktivt oändligt lån.

destinationLeaseAccessConditions?: LeaseAccessConditions

Egenskapsvärde

LeaseAccessConditions

filePermission

Valfritt. Om detta anges ska behörigheten (säkerhetsbeskrivning) anges för katalogen/filen.

filePermission?: string

Egenskapsvärde

string

filePermissionKey

Valfritt. Nyckeln för behörigheten som ska anges för katalogen/filen. Obs! Endast en av filePermission eller filePermissionKey ska anges.

filePermissionKey?: string

Egenskapsvärde

string

ignoreReadOnly

Valfritt. Ett booleskt värde som anger om attributet ReadOnly i en befintlig målfil ska respekteras. Om det är sant kommer namnbytet att lyckas, annars kommer en tidigare fil på målet med ReadOnly-attributuppsättningen att orsaka att namnbytet misslyckas.

ignoreReadOnly?: boolean

Egenskapsvärde

boolean

metadata

Ett namn/värde-par som ska associeras med ett fillagringsobjekt.

metadata?: Metadata

Egenskapsvärde

Metadata

replaceIfExists

Valfritt. Ett booleskt värde för om målfilen redan finns, oavsett om den här begäran kommer att skriva över filen eller inte. Om det är sant kommer namnbytet att lyckas och kommer att skriva över målfilen. Om det inte anges eller om det finns falskt och målfilen finns, kommer begäran inte att skriva över målfilen. Om det anges och målfilen inte finns lyckas namnbytet. Obs! Det här värdet åsidosätter inte huvudvärdet x-ms-file-copy-ignore-read-only.

replaceIfExists?: boolean

Egenskapsvärde

boolean

sourceLeaseAccessConditions

Villkor för låneåtkomst för källfilen. Krävs om källfilen har ett aktivt oändligt lån.

sourceLeaseAccessConditions?: LeaseAccessConditions

Egenskapsvärde

LeaseAccessConditions

timeoutInSeconds

Valfritt. Timeout-parametern uttrycks i sekunder. Mer information finns i Ange tidsgränser för filtjänståtgärder.

timeoutInSeconds?: number

Egenskapsvärde

number

Information om ärvda egenskaper

tracingOptions

tracingOptions?: OperationTracingOptions

Egenskapsvärde

OperationTracingOptions

Ärvd frånCommonOptions.tracingOptions