DirectoryRenameOptions interface

Pakket:

@azure/storage-file-share

Opties voor het configureren van de naam van de de naam van bewerking.

Uitbreiding

CommonOptions

Eigenschappen

abortSignal	Een implementatie van de AbortSignalLike-interface om de aanvraag te signaleren om de bewerking te annuleren. Gebruik bijvoorbeeld de @azure/abort-controller om een AbortSignalte maken.
copyFileSmbInfo	Optional. Hiermee geeft u de optie voor het kopiëren van de bestandsbeveiligingsdescriptor uit het bronbestand of om deze in te stellen met behulp van de waarde die is gedefinieerd door de headerwaarde van x-ms-file-permission-key of x-ms-file-permission-key.
destinationLeaseAccessConditions	Voorwaarde voor leasetoegang voor doelbestand. Vereist als het doelbestand een actieve oneindige lease heeft.
filePermission	Optional. Indien opgegeven moet de machtiging (beveiligingsdescriptor) worden ingesteld voor de map/het bestand.
filePermissionFormat	Optional. Beschikbaar voor versie 2023-06-01 en hoger. Hiermee geeft u de indeling op waarin de machtiging wordt geretourneerd. Acceptabele waarden zijn SDDL of binair. Als x-ms-file-permission-format niet is opgegeven of expliciet is ingesteld op SDDL, wordt de machtiging geretourneerd in SDDL-indeling. Als x-ms-file-permission-format expliciet is ingesteld op binair, wordt de machtiging geretourneerd als een base64-tekenreeks die de binaire codering van de machtiging vertegenwoordigt
filePermissionKey	Optional. Sleutel van de machtiging die moet worden ingesteld voor de map/het bestand. Opmerking: er moet slechts één van de filePermission of filePermissionKey worden opgegeven.
ignoreReadOnly	Optional. Een Booleaanse waarde die aangeeft of het kenmerk ReadOnly op een vooraf bestaande doelbestand moet worden gerespecteerd. Als waar is, slaagt de naam ervan, anders mislukt de naam van een eerder bestand op de bestemming met de set ReadOnly-kenmerken.
metadata	Optional. Een naam-waardepaar dat moet worden gekoppeld aan een bestandsopslagobject.
replaceIfExists	Optional. Een Booleaanse waarde voor als het doelbestand al bestaat, of deze aanvraag het bestand overschrijft of niet. Indien waar, slaagt de naam en wordt het doelbestand overschreven. Als dit niet is opgegeven of onwaar is en het doelbestand wel bestaat, wordt het doelbestand niet overschreven door de aanvraag. Als dit is opgegeven en het doelbestand niet bestaat, slaagt de naam ervan. Opmerking: deze waarde overschrijft de headerwaarde x-ms-file-copy-ignore-read-only niet.
sourceLeaseAccessConditions	Leasetoegangsvoorwaarde voor bronbestand. Vereist als het bronbestand een actieve oneindige lease heeft.
timeoutInSeconds	Optional. De time-outparameter wordt uitgedrukt in seconden. Zie Time-outs instellen voor bestandsservicebewerkingen voor meer informatie.

Overgenomen eigenschappen

tracingOptions

Eigenschapdetails

abortSignal

Een implementatie van de AbortSignalLike-interface om de aanvraag te signaleren om de bewerking te annuleren. Gebruik bijvoorbeeld de @azure/abort-controller om een AbortSignalte maken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

copyFileSmbInfo

Optional. Hiermee geeft u de optie voor het kopiëren van de bestandsbeveiligingsdescriptor uit het bronbestand of om deze in te stellen met behulp van de waarde die is gedefinieerd door de headerwaarde van x-ms-file-permission-key of x-ms-file-permission-key.

copyFileSmbInfo?: CopyFileSmbInfo

Waarde van eigenschap

CopyFileSmbInfo

destinationLeaseAccessConditions

Voorwaarde voor leasetoegang voor doelbestand. Vereist als het doelbestand een actieve oneindige lease heeft.

destinationLeaseAccessConditions?: LeaseAccessConditions

Waarde van eigenschap

LeaseAccessConditions

filePermission

Optional. Indien opgegeven moet de machtiging (beveiligingsdescriptor) worden ingesteld voor de map/het bestand.

filePermission?: string

Waarde van eigenschap

string

filePermissionFormat

Optional. Beschikbaar voor versie 2023-06-01 en hoger. Hiermee geeft u de indeling op waarin de machtiging wordt geretourneerd. Acceptabele waarden zijn SDDL of binair. Als x-ms-file-permission-format niet is opgegeven of expliciet is ingesteld op SDDL, wordt de machtiging geretourneerd in SDDL-indeling. Als x-ms-file-permission-format expliciet is ingesteld op binair, wordt de machtiging geretourneerd als een base64-tekenreeks die de binaire codering van de machtiging vertegenwoordigt

filePermissionFormat?: FilePermissionFormat

Waarde van eigenschap

FilePermissionFormat

filePermissionKey

Optional. Sleutel van de machtiging die moet worden ingesteld voor de map/het bestand. Opmerking: er moet slechts één van de filePermission of filePermissionKey worden opgegeven.

filePermissionKey?: string

Waarde van eigenschap

string

ignoreReadOnly

Optional. Een Booleaanse waarde die aangeeft of het kenmerk ReadOnly op een vooraf bestaande doelbestand moet worden gerespecteerd. Als waar is, slaagt de naam ervan, anders mislukt de naam van een eerder bestand op de bestemming met de set ReadOnly-kenmerken.

ignoreReadOnly?: boolean

Waarde van eigenschap

boolean

metadata

Optional. Een naam-waardepaar dat moet worden gekoppeld aan een bestandsopslagobject.

metadata?: Metadata

Waarde van eigenschap

Metadata

replaceIfExists

Optional. Een Booleaanse waarde voor als het doelbestand al bestaat, of deze aanvraag het bestand overschrijft of niet. Indien waar, slaagt de naam en wordt het doelbestand overschreven. Als dit niet is opgegeven of onwaar is en het doelbestand wel bestaat, wordt het doelbestand niet overschreven door de aanvraag. Als dit is opgegeven en het doelbestand niet bestaat, slaagt de naam ervan. Opmerking: deze waarde overschrijft de headerwaarde x-ms-file-copy-ignore-read-only niet.

replaceIfExists?: boolean

Waarde van eigenschap

boolean

sourceLeaseAccessConditions

Leasetoegangsvoorwaarde voor bronbestand. Vereist als het bronbestand een actieve oneindige lease heeft.

sourceLeaseAccessConditions?: LeaseAccessConditions

Waarde van eigenschap

LeaseAccessConditions

timeoutInSeconds

Optional. De time-outparameter wordt uitgedrukt in seconden. Zie Time-outs instellen voor bestandsservicebewerkingen voor meer informatie.

timeoutInSeconds?: number

Waarde van eigenschap

number

Details van overgenomen eigenschap

tracingOptions

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

Overgeërfd vanCommonOptions.tracingOptions