FileRenameOptions interface

Paket:

@azure/storage-file-share

Alternativ för att konfigurera byta namn på åtgärd.

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	Optional. Innehållstyp som ska anges på filen.
copyFileSmbInfo	Optional. Anger alternativet att kopiera filsäkerhetsbeskrivningen från källfilen eller ange den med det värde 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	Optional. Om det anges ska behörigheten (säkerhetsbeskrivningen) anges för katalogen/filen.
filePermissionFormat	Optional. Tillgänglig för version 2023-06-01 och senare. Anger i vilket format behörigheten returneras. Acceptabla värden är SDDL eller binärt. Om x-ms-file-permission-format är ospecificerat eller uttryckligen inställt på SDDL returneras behörigheten i SDDL-format. Om x-ms-file-permission-format uttryckligen anges till binär returneras behörigheten som en base64-sträng som representerar den binära kodningen av behörigheten
filePermissionKey	Optional. Nyckeln för behörigheten som ska anges för katalogen/filen. Obs! Endast en av filePermission eller filePermissionKey ska anges.
ignoreReadOnly	Optional. Ett booleskt värde som anger om attributet ReadOnly på en befintlig målfil ska respekteras. Om det är sant lyckas namnbytet, annars misslyckas en tidigare fil på målet med readOnly-attributuppsättningen.
metadata	Ett namn/värde-par som ska associeras med ett fillagringsobjekt.
replaceIfExists	Optional. Ett booleskt värde för om målfilen redan finns, oavsett om den här begäran skriver över filen eller inte. Om det är sant lyckas namnbytet och skriver över målfilen. Om det inte anges eller om det finns false och målfilen finns, skriver begäran inte över målfilen. Om den tillhandahålls och målfilen inte finns kommer namnbytet att lyckas. Obs! Det här värdet åsidosätter inte rubrikvä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	Optional. Tidsgränsparametern 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

Optional. Innehållstyp som ska anges på filen.

contentType?: string

Egenskapsvärde

string

copyFileSmbInfo

Optional. Anger alternativet att kopiera filsäkerhetsbeskrivningen från källfilen eller ange den med det värde 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

Optional. Om det anges ska behörigheten (säkerhetsbeskrivningen) anges för katalogen/filen.

filePermission?: string

Egenskapsvärde

string

filePermissionFormat

Optional. Tillgänglig för version 2023-06-01 och senare. Anger i vilket format behörigheten returneras. Acceptabla värden är SDDL eller binärt. Om x-ms-file-permission-format är ospecificerat eller uttryckligen inställt på SDDL returneras behörigheten i SDDL-format. Om x-ms-file-permission-format uttryckligen anges till binär returneras behörigheten som en base64-sträng som representerar den binära kodningen av behörigheten

filePermissionFormat?: FilePermissionFormat

Egenskapsvärde

FilePermissionFormat

filePermissionKey

Optional. 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

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

ignoreReadOnly?: boolean

Egenskapsvärde

boolean

metadata

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

metadata?: Metadata

Egenskapsvärde

Metadata

replaceIfExists

Optional. Ett booleskt värde för om målfilen redan finns, oavsett om den här begäran skriver över filen eller inte. Om det är sant lyckas namnbytet och skriver över målfilen. Om det inte anges eller om det finns false och målfilen finns, skriver begäran inte över målfilen. Om den tillhandahålls och målfilen inte finns kommer namnbytet att lyckas. Obs! Det här värdet åsidosätter inte rubrikvä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

Optional. Tidsgränsparametern 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