FileRenameOptions interface

Pacchetto:

@azure/storage-file-share

Opzioni per configurare l'operazione di ridenominazione .

Extends

CommonOptions

Proprietà

abortSignal	Implementazione dell'interfaccia AbortSignalLike per segnalare la richiesta di annullare l'operazione. Ad esempio, usare il @azure/abort-controller per creare un AbortSignaloggetto .
contentType	Facoltativa. Tipo di contenuto da impostare nel file.
copyFileSmbInfo	Facoltativa. Specifica l'opzione per copiare il descrittore di sicurezza dei file dal file di origine o impostarlo usando il valore definito dal valore di intestazione x-ms-file-permission o x-ms-file-permission-key.
destinationLeaseAccessConditions	Condizione di accesso lease per il file di destinazione. Obbligatorio se il file di destinazione ha un lease infinito attivo.
filePermission	Facoltativa. Se è stata specificata l'autorizzazione (descrittore di sicurezza) deve essere impostata per la directory/file.
filePermissionKey	Facoltativa. Chiave dell'autorizzazione da impostare per la directory/file. Nota: deve essere specificato solo uno dei filePermission o filePermissionKey.
ignoreReadOnly	Facoltativa. Valore booleano che specifica se l'attributo ReadOnly in un file di destinazione preesistente deve essere rispettato. Se true, la ridenominazione avrà esito positivo, in caso contrario, un file precedente nella destinazione con il set di attributi ReadOnly causerà l'esito negativo della ridenominazione.
metadata	Coppia nome-valore da associare a un oggetto di archiviazione file.
replaceIfExists	Facoltativa. Valore booleano per se il file di destinazione esiste già, se questa richiesta sovrascrive o meno il file. Se true, la ridenominazione avrà esito positivo e sovrascriverà il file di destinazione. Se non specificato o se false e il file di destinazione esiste, la richiesta non sovrascriverà il file di destinazione. Se specificato e il file di destinazione non esiste, la ridenominazione avrà esito positivo. Nota: questo valore non esegue l'override del valore dell'intestazione x-ms-file-copy-ignore-read-only.
sourceLeaseAccessConditions	Condizione di accesso lease per il file di origine. Obbligatorio se il file di origine ha un lease infinito attivo.
timeoutInSeconds	Facoltativa. Il parametro timeout viene espresso in secondi. Per altre informazioni, vedere Impostazione dei timeout per le operazioni del servizio file.

Proprietà ereditate

tracingOptions

Dettagli proprietà

abortSignal

Implementazione dell'interfaccia AbortSignalLike per segnalare la richiesta di annullare l'operazione. Ad esempio, usare il @azure/abort-controller per creare un AbortSignaloggetto .

abortSignal?: AbortSignalLike

Valore della proprietà

AbortSignalLike

contentType

Facoltativa. Tipo di contenuto da impostare nel file.

contentType?: string

Valore della proprietà

string

copyFileSmbInfo

Facoltativa. Specifica l'opzione per copiare il descrittore di sicurezza dei file dal file di origine o impostarlo usando il valore definito dal valore di intestazione x-ms-file-permission o x-ms-file-permission-key.

copyFileSmbInfo?: CopyFileSmbInfo

Valore della proprietà

CopyFileSmbInfo

destinationLeaseAccessConditions

Condizione di accesso lease per il file di destinazione. Obbligatorio se il file di destinazione ha un lease infinito attivo.

destinationLeaseAccessConditions?: LeaseAccessConditions

Valore della proprietà

LeaseAccessConditions

filePermission

Facoltativa. Se è stata specificata l'autorizzazione (descrittore di sicurezza) deve essere impostata per la directory/file.

filePermission?: string

Valore della proprietà

string

filePermissionKey

Facoltativa. Chiave dell'autorizzazione da impostare per la directory/file. Nota: deve essere specificato solo uno dei filePermission o filePermissionKey.

filePermissionKey?: string

Valore della proprietà

string

ignoreReadOnly

Facoltativa. Valore booleano che specifica se l'attributo ReadOnly in un file di destinazione preesistente deve essere rispettato. Se true, la ridenominazione avrà esito positivo, in caso contrario, un file precedente nella destinazione con il set di attributi ReadOnly causerà l'esito negativo della ridenominazione.

ignoreReadOnly?: boolean

Valore della proprietà

boolean

metadata

Coppia nome-valore da associare a un oggetto di archiviazione file.

metadata?: Metadata

Valore della proprietà

Metadata

replaceIfExists

Facoltativa. Valore booleano per se il file di destinazione esiste già, se questa richiesta sovrascrive o meno il file. Se true, la ridenominazione avrà esito positivo e sovrascriverà il file di destinazione. Se non specificato o se false e il file di destinazione esiste, la richiesta non sovrascriverà il file di destinazione. Se specificato e il file di destinazione non esiste, la ridenominazione avrà esito positivo. Nota: questo valore non esegue l'override del valore dell'intestazione x-ms-file-copy-ignore-read-only.

replaceIfExists?: boolean

Valore della proprietà

boolean

sourceLeaseAccessConditions

Condizione di accesso lease per il file di origine. Obbligatorio se il file di origine ha un lease infinito attivo.

sourceLeaseAccessConditions?: LeaseAccessConditions

Valore della proprietà

LeaseAccessConditions

timeoutInSeconds

Facoltativa. Il parametro timeout viene espresso in secondi. Per altre informazioni, vedere Impostazione dei timeout per le operazioni del servizio file.

timeoutInSeconds?: number

Valore della proprietà

number

Dettagli proprietà ereditate

tracingOptions

tracingOptions?: OperationTracingOptions

Valore della proprietà

OperationTracingOptions

Ereditato daCommonOptions.tracingOptions