FileRenameOptions interface

Пакет:

@azure/storage-file-share

Параметры настройки операции переименования .

Extends

CommonOptions

Свойства

abortSignal	Реализация интерфейса AbortSignalLike для сигнала о запросе на отмену операции. Например, используйте контроллер @azure/abort-controller для создания AbortSignal.
contentType	Optional. Тип контента, заданный в файле.
copyFileSmbInfo	Optional. Указывает параметр копирования дескриптора безопасности файлов из исходного файла или задания его с помощью значения заголовка x-ms-file-permission или x-ms-file-permission-key.
destinationLeaseAccessConditions	Условие доступа аренды для целевого файла. Требуется, если целевой файл имеет активную бесконечную аренду.
filePermission	Optional. Если задано разрешение (дескриптор безопасности), необходимо задать для каталога или файла.
filePermissionFormat	Optional. Доступно для версии 2023-06-01 и более поздних версий. Указывает формат, в котором возвращается разрешение. Допустимыми значениями являются SDDL или двоичные значения. Если формат разрешений x-ms-file-permission-format не указан или явно задан в SDDL, разрешение возвращается в формате SDDL. Если для x-ms-file-permission-format явно задан двоичный формат, разрешение возвращается в виде строки base64, представляющей двоичную кодировку разрешения.
filePermissionKey	Optional. Ключ разрешения, заданного для каталога или файла. Примечание. Необходимо указать только один из filePermission или filePermissionKey.
ignoreReadOnly	Optional. Логическое значение, указывающее, следует ли учитывать атрибут ReadOnly в предварительном целевом файле. Если значение true, переименование завершится успешно, в противном случае предыдущий файл в назначении с набором атрибутов ReadOnly приведет к сбою переименования.
metadata	Пара "имя-значение", связанная с объектом хранилища файлов.
replaceIfExists	Optional. Логическое значение, если целевой файл уже существует, будет ли этот запрос перезаписывать файл или нет. Если значение true, переименование завершится успешно и перезаписывает целевой файл. Если файл не указан или если значение false и целевой файл существует, запрос не перезаписывает целевой файл. Если указано и целевой файл не существует, переименование завершится успешно. Примечание. Это значение не переопределяет значение заголовка x-ms-file-copy-ignore-read-only.
sourceLeaseAccessConditions	Условие доступа к аренде исходного файла. Требуется, если исходный файл имеет активную бесконечную аренду.
timeoutInSeconds	Optional. Параметр времени ожидания выражается в секундах. Дополнительные сведения см. в разделе Настройка времени ожидания для операций службы файлов.

Унаследованные свойства

tracingOptions

Сведения о свойстве

abortSignal

Реализация интерфейса AbortSignalLike для сигнала о запросе на отмену операции. Например, используйте контроллер @azure/abort-controller для создания AbortSignal.

abortSignal?: AbortSignalLike

Значение свойства

AbortSignalLike

contentType

Optional. Тип контента, заданный в файле.

contentType?: string

Значение свойства

string

copyFileSmbInfo

Optional. Указывает параметр копирования дескриптора безопасности файлов из исходного файла или задания его с помощью значения заголовка x-ms-file-permission или x-ms-file-permission-key.

copyFileSmbInfo?: CopyFileSmbInfo

Значение свойства

CopyFileSmbInfo

destinationLeaseAccessConditions

Условие доступа аренды для целевого файла. Требуется, если целевой файл имеет активную бесконечную аренду.

destinationLeaseAccessConditions?: LeaseAccessConditions

Значение свойства

LeaseAccessConditions

filePermission

Optional. Если задано разрешение (дескриптор безопасности), необходимо задать для каталога или файла.

filePermission?: string

Значение свойства

string

filePermissionFormat

Optional. Доступно для версии 2023-06-01 и более поздних версий. Указывает формат, в котором возвращается разрешение. Допустимыми значениями являются SDDL или двоичные значения. Если формат разрешений x-ms-file-permission-format не указан или явно задан в SDDL, разрешение возвращается в формате SDDL. Если для x-ms-file-permission-format явно задан двоичный формат, разрешение возвращается в виде строки base64, представляющей двоичную кодировку разрешения.

filePermissionFormat?: FilePermissionFormat

Значение свойства

FilePermissionFormat

filePermissionKey

Optional. Ключ разрешения, заданного для каталога или файла. Примечание. Необходимо указать только один из filePermission или filePermissionKey.

filePermissionKey?: string

Значение свойства

string

ignoreReadOnly

Optional. Логическое значение, указывающее, следует ли учитывать атрибут ReadOnly в предварительном целевом файле. Если значение true, переименование завершится успешно, в противном случае предыдущий файл в назначении с набором атрибутов ReadOnly приведет к сбою переименования.

ignoreReadOnly?: boolean

Значение свойства

boolean

metadata

Пара "имя-значение", связанная с объектом хранилища файлов.

metadata?: Metadata

Значение свойства

Metadata

replaceIfExists

Optional. Логическое значение, если целевой файл уже существует, будет ли этот запрос перезаписывать файл или нет. Если значение true, переименование завершится успешно и перезаписывает целевой файл. Если файл не указан или если значение false и целевой файл существует, запрос не перезаписывает целевой файл. Если указано и целевой файл не существует, переименование завершится успешно. Примечание. Это значение не переопределяет значение заголовка x-ms-file-copy-ignore-read-only.

replaceIfExists?: boolean

Значение свойства

boolean

sourceLeaseAccessConditions

Условие доступа к аренде исходного файла. Требуется, если исходный файл имеет активную бесконечную аренду.

sourceLeaseAccessConditions?: LeaseAccessConditions

Значение свойства

LeaseAccessConditions

timeoutInSeconds

Optional. Параметр времени ожидания выражается в секундах. Дополнительные сведения см. в разделе Настройка времени ожидания для операций службы файлов.

timeoutInSeconds?: number

Значение свойства

number

Сведения об унаследованном свойстве

tracingOptions

tracingOptions?: OperationTracingOptions

Значение свойства

OperationTracingOptions

Наследуется отCommonOptions.tracingOptions