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 AbortSignal.
contentType	Optional. Tipo di contenuto da impostare nel file.
copyFileSmbInfo	Optional. 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	Optional. Se è stata specificata l'autorizzazione (descrittore di sicurezza) deve essere impostata per la directory o il file.
filePermissionFormat	Optional. Disponibile per la versione 2023-06-01 e successive. Specifica il formato in cui viene restituita l'autorizzazione. I valori accettabili sono SDDL o binari. Se x-ms-file-permission-format non è specificato o impostato in modo esplicito su SDDL, l'autorizzazione viene restituita in formato SDDL. Se x-ms-file-permission-format è impostato in modo esplicito su binario, l'autorizzazione viene restituita come stringa base64 che rappresenta la codifica binaria dell'autorizzazione
filePermissionKey	Optional. Chiave dell'autorizzazione da impostare per la directory/file. Nota: è necessario specificare solo uno dei filePermission o filePermissionKey.
ignoreReadOnly	Optional. 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	Optional. Valore booleano per se il file di destinazione esiste già, se la richiesta sovrascriverà o meno il file. Se true, la ridenominazione avrà esito positivo e sovrascriverà il file di destinazione. Se non viene 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	Optional. Il parametro di timeout è espresso in secondi. Per altre informazioni, vedere Impostazione di 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 AbortSignal.

abortSignal?: AbortSignalLike

Valore della proprietà

AbortSignalLike

contentType

Optional. Tipo di contenuto da impostare nel file.

contentType?: string

Valore della proprietà

string

copyFileSmbInfo

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

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

filePermission?: string

Valore della proprietà

string

filePermissionFormat

Optional. Disponibile per la versione 2023-06-01 e successive. Specifica il formato in cui viene restituita l'autorizzazione. I valori accettabili sono SDDL o binari. Se x-ms-file-permission-format non è specificato o impostato in modo esplicito su SDDL, l'autorizzazione viene restituita in formato SDDL. Se x-ms-file-permission-format è impostato in modo esplicito su binario, l'autorizzazione viene restituita come stringa base64 che rappresenta la codifica binaria dell'autorizzazione

filePermissionFormat?: FilePermissionFormat

Valore della proprietà

FilePermissionFormat

filePermissionKey

Optional. Chiave dell'autorizzazione da impostare per la directory/file. Nota: è necessario specificare solo uno dei filePermission o filePermissionKey.

filePermissionKey?: string

Valore della proprietà

string

ignoreReadOnly

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

Optional. Valore booleano per se il file di destinazione esiste già, se la richiesta sovrascriverà o meno il file. Se true, la ridenominazione avrà esito positivo e sovrascriverà il file di destinazione. Se non viene 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

Optional. Il parametro di timeout è espresso in secondi. Per altre informazioni, vedere Impostazione di 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