FileRenameOptions interface

Pakiet:

@azure/storage-file-share

Opcje konfigurowania operacji zmiany nazwy.

Rozszerzenie

CommonOptions

Właściwości

abortSignal	Implementacja interfejsu AbortSignalLike sygnalizuje żądanie anulowania operacji. Na przykład użyj @azure/abort-controller, aby utworzyć AbortSignal.
contentType	Optional. Typ zawartości do ustawienia w pliku.
copyFileSmbInfo	Optional. 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	Optional. Jeśli określono uprawnienie (deskryptor zabezpieczeń) należy ustawić dla katalogu/pliku.
filePermissionFormat	Optional. Dostępne dla wersji 2023-06-01 lub nowszej. Określa format, w którym jest zwracane uprawnienie. Dopuszczalne wartości to SDDL lub binarne. Jeśli format x-ms-file-permission-format jest nieokreślony lub jawnie ustawiony na SDDL, uprawnienie jest zwracane w formacie SDDL. Jeśli format x-ms-file-permission-format jest jawnie ustawiony na binarny, uprawnienie jest zwracane jako ciąg base64 reprezentujący kodowanie binarne uprawnienia
filePermissionKey	Optional. Klucz uprawnienia do ustawienia dla katalogu/pliku. Uwaga: należy określić tylko jeden z plikówPermission lub filePermissionKey.
ignoreReadOnly	Optional. Wartość logiczna określająca, czy atrybut ReadOnly w wcześniej istniejących plikach docelowych powinien być przestrzegany. 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	Optional. 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 lub jeśli plik false i plik docelowy istnieje, żądanie nie zastąpi pliku docelowego. Jeśli zostanie podany i plik docelowy nie istnieje, zmiana nazwy powiedzie się. Uwaga: ta wartość nie zastępuje wartości nagłówka x-ms-file-copy-ignore-read-only.
sourceLeaseAccessConditions	Warunek dostępu dzierżawy dla pliku źródłowego. Wymagane, jeśli plik źródłowy ma aktywną nieskończoną dzierżawę.
timeoutInSeconds	Optional. 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ć AbortSignal.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

contentType

Optional. Typ zawartości do ustawienia w pliku.

contentType?: string

Wartość właściwości

string

copyFileSmbInfo

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

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

filePermission?: string

Wartość właściwości

string

filePermissionFormat

Optional. Dostępne dla wersji 2023-06-01 lub nowszej. Określa format, w którym jest zwracane uprawnienie. Dopuszczalne wartości to SDDL lub binarne. Jeśli format x-ms-file-permission-format jest nieokreślony lub jawnie ustawiony na SDDL, uprawnienie jest zwracane w formacie SDDL. Jeśli format x-ms-file-permission-format jest jawnie ustawiony na binarny, uprawnienie jest zwracane jako ciąg base64 reprezentujący kodowanie binarne uprawnienia

filePermissionFormat?: FilePermissionFormat

Wartość właściwości

FilePermissionFormat

filePermissionKey

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

Optional. Wartość logiczna określająca, czy atrybut ReadOnly w wcześniej istniejących plikach docelowych powinien być przestrzegany. 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

Optional. 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 lub jeśli plik false i plik docelowy istnieje, żądanie nie zastąpi pliku docelowego. Jeśli zostanie podany i plik docelowy nie istnieje, zmiana nazwy powiedzie się. 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 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

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

Odziedziczone poCommonOptions.tracingOptions