DirectoryRenameOptions interface

Paket:

@azure/storage-file-share

Optionen zum Konfigurieren des Umbenennungsvorgangs .

Extends

CommonOptions

Eigenschaften

abortSignal	Eine Implementierung der AbortSignalLike -Schnittstelle, die der Anforderung signalisiert, den Vorgang abzubrechen. Verwenden Sie beispielsweise den @azure/abort-controller, um eine AbortSignalzu erstellen.
copyFileSmbInfo	Dies ist optional. Gibt die Option an, die Dateisicherheitsbeschreibung aus der Quelldatei zu kopieren oder mit dem Wert festzulegen, der durch den Headerwert von x-ms-file-permission oder x-ms-file-permission-key definiert wird.
destinationLeaseAccessConditions	Leasezugriffsbedingung für die Zieldatei. Erforderlich, wenn die Zieldatei über eine aktive unendliche Lease verfügt.
filePermission	Dies ist optional. Wenn angegeben, muss die Berechtigung (Sicherheitsdeskriptor) für das Verzeichnis/die Datei festgelegt werden.
filePermissionKey	Dies ist optional. Schlüssel der Berechtigung, die für das Verzeichnis/die Datei festgelegt werden soll. Hinweis: Es sollte nur eine der FilePermission- oder filePermissionKey-Dateien angegeben werden.
ignoreReadOnly	Dies ist optional. Ein boolescher Wert, der angibt, ob das ReadOnly-Attribut für eine bereits vorhandene Zieldatei berücksichtigt werden soll. Wenn true, wird die Umbenennung erfolgreich ausgeführt, andernfalls führt eine vorherige Datei am Ziel mit festgelegtem ReadOnly-Attribut dazu, dass die Umbenennung fehlschlägt.
metadata	Dies ist optional. Ein Name-Wert-Paar, das einem Dateispeicherobjekt zugeordnet werden soll.
replaceIfExists	Dies ist optional. Ein boolescher Wert für, wenn die Zieldatei bereits vorhanden ist, unabhängig davon, ob diese Anforderung die Datei überschreibt oder nicht. Wenn true, wird die Umbenennung erfolgreich ausgeführt und die Zieldatei überschrieben. Wenn nicht angegeben oder false und die Zieldatei vorhanden ist, überschreibt die Anforderung die Zieldatei nicht. Wenn angegeben und die Zieldatei nicht vorhanden ist, ist die Umbenennung erfolgreich. Hinweis: Dieser Wert überschreibt den schreibgeschützten Headerwert x-ms-file-copy-ignore-nicht.
sourceLeaseAccessConditions	Leasezugriffsbedingung für die Quelldatei. Erforderlich, wenn die Quelldatei über eine aktive unendliche Lease verfügt.
timeoutInSeconds	Dies ist optional. Der timeout-Parameter wird in Sekunden angegeben. Weitere Informationen finden Sie unter Festlegen von Timeouts für Dateidienstvorgänge.

Geerbte Eigenschaften

tracingOptions

Details zur Eigenschaft

abortSignal

Eine Implementierung der AbortSignalLike -Schnittstelle, die der Anforderung signalisiert, den Vorgang abzubrechen. Verwenden Sie beispielsweise den @azure/abort-controller, um eine AbortSignalzu erstellen.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

copyFileSmbInfo

Dies ist optional. Gibt die Option an, die Dateisicherheitsbeschreibung aus der Quelldatei zu kopieren oder mit dem Wert festzulegen, der durch den Headerwert von x-ms-file-permission oder x-ms-file-permission-key definiert wird.

copyFileSmbInfo?: CopyFileSmbInfo

Eigenschaftswert

CopyFileSmbInfo

destinationLeaseAccessConditions

Leasezugriffsbedingung für die Zieldatei. Erforderlich, wenn die Zieldatei über eine aktive unendliche Lease verfügt.

destinationLeaseAccessConditions?: LeaseAccessConditions

Eigenschaftswert

LeaseAccessConditions

filePermission

Dies ist optional. Wenn angegeben, muss die Berechtigung (Sicherheitsdeskriptor) für das Verzeichnis/die Datei festgelegt werden.

filePermission?: string

Eigenschaftswert

string

filePermissionKey

Dies ist optional. Schlüssel der Berechtigung, die für das Verzeichnis/die Datei festgelegt werden soll. Hinweis: Es sollte nur eine der FilePermission- oder filePermissionKey-Dateien angegeben werden.

filePermissionKey?: string

Eigenschaftswert

string

ignoreReadOnly

Dies ist optional. Ein boolescher Wert, der angibt, ob das ReadOnly-Attribut für eine bereits vorhandene Zieldatei berücksichtigt werden soll. Wenn true, wird die Umbenennung erfolgreich ausgeführt, andernfalls führt eine vorherige Datei am Ziel mit festgelegtem ReadOnly-Attribut dazu, dass die Umbenennung fehlschlägt.

ignoreReadOnly?: boolean

Eigenschaftswert

boolean

metadata

Dies ist optional. Ein Name-Wert-Paar, das einem Dateispeicherobjekt zugeordnet werden soll.

metadata?: Metadata

Eigenschaftswert

Metadata

replaceIfExists

Dies ist optional. Ein boolescher Wert für, wenn die Zieldatei bereits vorhanden ist, unabhängig davon, ob diese Anforderung die Datei überschreibt oder nicht. Wenn true, wird die Umbenennung erfolgreich ausgeführt und die Zieldatei überschrieben. Wenn nicht angegeben oder false und die Zieldatei vorhanden ist, überschreibt die Anforderung die Zieldatei nicht. Wenn angegeben und die Zieldatei nicht vorhanden ist, ist die Umbenennung erfolgreich. Hinweis: Dieser Wert überschreibt den schreibgeschützten Headerwert x-ms-file-copy-ignore-nicht.

replaceIfExists?: boolean

Eigenschaftswert

boolean

sourceLeaseAccessConditions

Leasezugriffsbedingung für die Quelldatei. Erforderlich, wenn die Quelldatei über eine aktive unendliche Lease verfügt.

sourceLeaseAccessConditions?: LeaseAccessConditions

Eigenschaftswert

LeaseAccessConditions

timeoutInSeconds

Dies ist optional. Der timeout-Parameter wird in Sekunden angegeben. Weitere Informationen finden Sie unter Festlegen von Timeouts für Dateidienstvorgänge.

timeoutInSeconds?: number

Eigenschaftswert

number

Geerbte Eigenschaftsdetails

tracingOptions

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions

Geerbt vonCommonOptions.tracingOptions