FileRenameOptions interface

Pakket:

@azure/storage-file-share

Opties voor het configureren van de naamswijziging .

Extends

CommonOptions

Eigenschappen

abortSignal	Een implementatie van de AbortSignalLike interface om aan te geven dat de aanvraag de bewerking moet annuleren. Gebruik bijvoorbeeld de @azure/abort-controller om een AbortSignalte maken.
contentType	Optioneel. Inhoudstype dat moet worden ingesteld voor het bestand.
copyFileSmbInfo	Optioneel. Hiermee geeft u de optie voor het kopiëren van bestandsbeveiligingsdescriptor uit het bronbestand of om deze in te stellen met behulp van de waarde die wordt gedefinieerd door de headerwaarde van x-ms-file-permission of x-ms-file-permission-key.
destinationLeaseAccessConditions	Voorwaarde voor leasetoegang voor doelbestand. Vereist als het doelbestand een actieve oneindige lease heeft.
filePermission	Optioneel. Indien opgegeven moet de machtiging (security descriptor) worden ingesteld voor de map/het bestand.
filePermissionKey	Optioneel. 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	Optioneel. Een booleaanse waarde die aangeeft of het kenmerk ReadOnly op een al bestaande doelbestand moet worden gerespecteerd. Als waar is, slaagt de naam van de naam, anders mislukt de naam van een eerder bestand op de bestemming met het kenmerk ReadOnly.
metadata	Een naam-waardepaar om te koppelen aan een bestandsopslagobject.
replaceIfExists	Optioneel. Een booleaanse waarde voor als het doelbestand al bestaat, of deze aanvraag het bestand overschrijft of niet. Als de naam waar is, slaagt de naam en wordt het doelbestand overschreven. Als dit niet is opgegeven of als het doelbestand onwaar is en het doelbestand bestaat, wordt het doelbestand niet overschreven door de aanvraag. Als dit is opgegeven en het doelbestand niet bestaat, wordt de naam gewijzigd. Opmerking: deze waarde overschrijft de headerwaarde x-ms-file-copy-ignore-read-only niet.
sourceLeaseAccessConditions	Voorwaarde voor leasetoegang voor bronbestand. Vereist als het bronbestand een actieve oneindige lease heeft.
timeoutInSeconds	Optioneel. 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 aan te geven dat de aanvraag de bewerking moet annuleren. Gebruik bijvoorbeeld de @azure/abort-controller om een AbortSignalte maken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

contentType

Optioneel. Inhoudstype dat moet worden ingesteld voor het bestand.

contentType?: string

Waarde van eigenschap

string

copyFileSmbInfo

Optioneel. Hiermee geeft u de optie voor het kopiëren van bestandsbeveiligingsdescriptor uit het bronbestand of om deze in te stellen met behulp van de waarde die wordt gedefinieerd door de headerwaarde van x-ms-file-permission 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

Optioneel. Indien opgegeven moet de machtiging (security descriptor) worden ingesteld voor de map/het bestand.

filePermission?: string

Waarde van eigenschap

string

filePermissionKey

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

Optioneel. Een booleaanse waarde die aangeeft of het kenmerk ReadOnly op een al bestaande doelbestand moet worden gerespecteerd. Als waar is, slaagt de naam van de naam, anders mislukt de naam van een eerder bestand op de bestemming met het kenmerk ReadOnly.

ignoreReadOnly?: boolean

Waarde van eigenschap

boolean

metadata

Een naam-waardepaar om te koppelen aan een bestandsopslagobject.

metadata?: Metadata

Waarde van eigenschap

Metadata

replaceIfExists

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

replaceIfExists?: boolean

Waarde van eigenschap

boolean

sourceLeaseAccessConditions

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

sourceLeaseAccessConditions?: LeaseAccessConditions

Waarde van eigenschap

LeaseAccessConditions

timeoutInSeconds

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

Overgenomen vanCommonOptions.tracingOptions