FileRenameOptions interface

Pakiet:

@azure/storage-file-share

Opcje konfigurowania rename(string, FileRenameOptions) operacji.

Extends

CommonOptions

Właściwości

abortSignal	Implementacja interfejsu AbortSignalLike sygnalizuje żądanie anulowania operacji. Na przykład użyj @azure/abort-controller, aby utworzyć element AbortSignal.
contentType	Opcjonalny. Typ zawartości do ustawienia w pliku.
copyFileSmbInfo	Opcjonalny. Określa opcję kopiowania deskryptora zabezpieczeń plików z pliku źródłowego lub ustawiania go przy użyciu wartości nagłówka x-ms-file-permission lub x-ms-file-permission-key.
destinationLeaseAccessConditions	Warunek dostępu dzierżawy dla pliku docelowego. Wymagane, jeśli plik docelowy ma aktywną nieskończoną dzierżawę.
filePermission	Opcjonalny. Jeśli określono uprawnienie (deskryptor zabezpieczeń) należy ustawić dla katalogu/pliku.
filePermissionKey	Opcjonalny. Klucz uprawnienia do ustawienia dla katalogu/pliku. Uwaga: należy określić tylko jeden z plikówPermission lub filePermissionKey.
ignoreReadOnly	Opcjonalny. Wartość logiczna określająca, czy należy przestrzegać atrybutu ReadOnly dla istniejącego pliku docelowego. Jeśli wartość true, zmiana nazwy powiedzie się, w przeciwnym razie poprzedni plik w miejscu docelowym z zestawem atrybutów ReadOnly spowoduje niepowodzenie zmiany nazwy.
metadata	Para name-value do skojarzenia z obiektem magazynu plików.
replaceIfExists	Opcjonalny. Wartość logiczna, jeśli plik docelowy już istnieje, czy to żądanie zastąpi plik, czy nie. Jeśli wartość true, zmiana nazwy powiedzie się i zastąpi plik docelowy. Jeśli nie podano wartości lub jeśli plik docelowy istnieje, żądanie nie zastąpi pliku docelowego. Jeśli plik docelowy nie istnieje, zmiana nazwy zakończy się pomyślnie. Uwaga: ta wartość nie zastępuje wartości nagłówka x-ms-file-copy-ignore-read-only.
sourceLeaseAccessConditions	Warunek dostępu do dzierżawy dla pliku źródłowego. Wymagane, jeśli plik źródłowy ma aktywną nieskończoną dzierżawę.
timeoutInSeconds	Opcjonalny. Parametr limitu czasu jest wyrażony w sekundach. Aby uzyskać więcej informacji, zobacz Ustawianie limitów czasu dla operacji usługi plików.

Właściwości dziedziczone

tracingOptions

Szczegóły właściwości

abortSignal

Implementacja interfejsu AbortSignalLike sygnalizuje żądanie anulowania operacji. Na przykład użyj @azure/abort-controller, aby utworzyć element AbortSignal.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

contentType

Opcjonalny. Typ zawartości do ustawienia w pliku.

contentType?: string

Wartość właściwości

string

copyFileSmbInfo

Opcjonalny. Określa opcję kopiowania deskryptora zabezpieczeń plików z pliku źródłowego lub ustawiania go przy użyciu wartości nagłówka x-ms-file-permission lub x-ms-file-permission-key.

copyFileSmbInfo?: CopyFileSmbInfo

Wartość właściwości

CopyFileSmbInfo

destinationLeaseAccessConditions

Warunek dostępu dzierżawy dla pliku docelowego. Wymagane, jeśli plik docelowy ma aktywną nieskończoną dzierżawę.

destinationLeaseAccessConditions?: LeaseAccessConditions

Wartość właściwości

LeaseAccessConditions

filePermission

Opcjonalny. Jeśli określono uprawnienie (deskryptor zabezpieczeń) należy ustawić dla katalogu/pliku.

filePermission?: string

Wartość właściwości

string

filePermissionKey

Opcjonalny. Klucz uprawnienia do ustawienia dla katalogu/pliku. Uwaga: należy określić tylko jeden z plikówPermission lub filePermissionKey.

filePermissionKey?: string

Wartość właściwości

string

ignoreReadOnly

Opcjonalny. Wartość logiczna określająca, czy należy przestrzegać atrybutu ReadOnly dla istniejącego pliku docelowego. Jeśli wartość true, zmiana nazwy powiedzie się, w przeciwnym razie poprzedni plik w miejscu docelowym z zestawem atrybutów ReadOnly spowoduje niepowodzenie zmiany nazwy.

ignoreReadOnly?: boolean

Wartość właściwości

boolean

metadata

Para name-value do skojarzenia z obiektem magazynu plików.

metadata?: Metadata

Wartość właściwości

Metadata

replaceIfExists

Opcjonalny. Wartość logiczna, jeśli plik docelowy już istnieje, czy to żądanie zastąpi plik, czy nie. Jeśli wartość true, zmiana nazwy powiedzie się i zastąpi plik docelowy. Jeśli nie podano wartości lub jeśli plik docelowy istnieje, żądanie nie zastąpi pliku docelowego. Jeśli plik docelowy nie istnieje, zmiana nazwy zakończy się pomyślnie. Uwaga: ta wartość nie zastępuje wartości nagłówka x-ms-file-copy-ignore-read-only.

replaceIfExists?: boolean

Wartość właściwości

boolean

sourceLeaseAccessConditions

Warunek dostępu do dzierżawy dla pliku źródłowego. Wymagane, jeśli plik źródłowy ma aktywną nieskończoną dzierżawę.

sourceLeaseAccessConditions?: LeaseAccessConditions

Wartość właściwości

LeaseAccessConditions

timeoutInSeconds

Opcjonalny. Parametr limitu czasu jest wyrażony w sekundach. Aby uzyskać więcej informacji, zobacz Ustawianie limitów czasu dla operacji usługi plików.

timeoutInSeconds?: number

Wartość właściwości

number

Szczegóły właściwości dziedziczonej

tracingOptions

tracingOptions?: OperationTracingOptions

Wartość właściwości

OperationTracingOptions

Dziedziczone zcommonOptions.tracingOptions