File class
Класс, представляющий файл.
Конструкторы
| File(Storage |
Создайте файл. |
Методы
Сведения о конструкторе
File(StorageClientContext)
Создайте файл.
new File(client: StorageClientContext)
Параметры
- client
- StorageClientContext
Ссылка на клиент службы.
Сведения о методе
abortCopy(string, FileAbortCopyOptionalParams, ServiceCallback<void>)
function abortCopy(copyId: string, options: FileAbortCopyOptionalParams, callback: ServiceCallback<void>)
Параметры
- copyId
-
string
Идентификатор копирования, указанный в заголовке x-ms-copy-id исходной операции копирования файла.
- options
- FileAbortCopyOptionalParams
Необязательные параметры
- callback
-
ServiceCallback<void>
Обратный вызов
abortCopy(string, Models.FileAbortCopyOptionalParams)
Прервана ожидающая операция копирования файла и оставляет целевой файл с нулевой длиной и полными метаданными.
function abortCopy(copyId: string, options?: Models.FileAbortCopyOptionalParams)
Параметры
- copyId
-
string
Идентификатор копирования, указанный в заголовке x-ms-copy-id исходной операции копирования файла.
- options
- Models.FileAbortCopyOptionalParams
Возвращаемое значение
Promise<Models.FileAbortCopyResponse>
Обещание<Models.FileAbortCopyResponse>
abortCopy(string, ServiceCallback<void>)
function abortCopy(copyId: string, callback: ServiceCallback<void>)
Параметры
- copyId
-
string
Идентификатор копирования, указанный в заголовке x-ms-copy-id исходной операции копирования файла.
- callback
-
ServiceCallback<void>
Обратный вызов
create(number, string, string, string, FileCreateOptionalParams, ServiceCallback<void>)
function create(fileContentLength: number, fileAttributes: string, fileCreationTime: string, fileLastWriteTime: string, options: FileCreateOptionalParams, callback: ServiceCallback<void>)
Параметры
- fileContentLength
-
number
Задает максимальный размер файла до 1 ТБ.
- fileAttributes
-
string
Если задано, указанные атрибуты файла должны быть заданы. Значение по умолчанию: "Архив" для файла и каталога. Значение "Нет" также можно указать как значение по умолчанию.
- fileCreationTime
-
string
Время создания файла или каталога.
- fileLastWriteTime
-
string
Время последней записи для файла или каталога.
- options
- FileCreateOptionalParams
Необязательные параметры
- callback
-
ServiceCallback<void>
Обратный вызов
create(number, string, string, string, Models.FileCreateOptionalParams)
Создает новый файл или заменяет файл. Обратите внимание, что файл инициализируется только без содержимого.
function create(fileContentLength: number, fileAttributes: string, fileCreationTime: string, fileLastWriteTime: string, options?: Models.FileCreateOptionalParams)
Параметры
- fileContentLength
-
number
Задает максимальный размер файла до 1 ТБ.
- fileAttributes
-
string
Если задано, указанные атрибуты файла должны быть заданы. Значение по умолчанию: "Архив" для файла и каталога. Значение "Нет" также можно указать как значение по умолчанию.
- fileCreationTime
-
string
Время создания файла или каталога.
- fileLastWriteTime
-
string
Время последней записи для файла или каталога.
- options
- Models.FileCreateOptionalParams
Возвращаемое значение
Promise<Models.FileCreateResponse>
Обещание<Models.FileCreateResponse>
create(number, string, string, string, ServiceCallback<void>)
function create(fileContentLength: number, fileAttributes: string, fileCreationTime: string, fileLastWriteTime: string, callback: ServiceCallback<void>)
Параметры
- fileContentLength
-
number
Задает максимальный размер файла до 1 ТБ.
- fileAttributes
-
string
Если задано, указанные атрибуты файла должны быть заданы. Значение по умолчанию: "Архив" для файла и каталога. Значение "Нет" также можно указать как значение по умолчанию.
- fileCreationTime
-
string
Время создания файла или каталога.
- fileLastWriteTime
-
string
Время последней записи для файла или каталога.
- callback
-
ServiceCallback<void>
Обратный вызов
deleteMethod(FileDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(options: FileDeleteMethodOptionalParams, callback: ServiceCallback<void>)
Параметры
- options
- FileDeleteMethodOptionalParams
Необязательные параметры
- callback
-
ServiceCallback<void>
Обратный вызов
deleteMethod(Models.FileDeleteMethodOptionalParams)
Удаляет файл из учетной записи хранения.
function deleteMethod(options?: Models.FileDeleteMethodOptionalParams)
Параметры
- options
- Models.FileDeleteMethodOptionalParams
Возвращаемое значение
Promise<Models.FileDeleteResponse>
Обещание<Models.FileDeleteResponse>
deleteMethod(ServiceCallback<void>)
function deleteMethod(callback: ServiceCallback<void>)
Параметры
- callback
-
ServiceCallback<void>
Обратный вызов
download(FileDownloadOptionalParams, ServiceCallback<void>)
function download(options: FileDownloadOptionalParams, callback: ServiceCallback<void>)
Параметры
- options
- FileDownloadOptionalParams
Необязательные параметры
- callback
-
ServiceCallback<void>
Обратный вызов
download(Models.FileDownloadOptionalParams)
Считывает или загружает файл из системы, включая его метаданные и свойства.
function download(options?: Models.FileDownloadOptionalParams)
Параметры
- options
- Models.FileDownloadOptionalParams
Возвращаемое значение
Promise<Models.FileDownloadResponse>
Обещание<Models.FileDownloadResponse>
download(ServiceCallback<void>)
function download(callback: ServiceCallback<void>)
Параметры
- callback
-
ServiceCallback<void>
Обратный вызов
forceCloseHandles(string, FileForceCloseHandlesOptionalParams, ServiceCallback<void>)
function forceCloseHandles(handleId: string, options: FileForceCloseHandlesOptionalParams, callback: ServiceCallback<void>)
Параметры
- handleId
-
string
Указывает идентификатор дескриптора, открытый в файле или каталоге для закрытия. Asterix ('*) — это подстановочный знак, указывающий все дескрипторы.
Необязательные параметры
- callback
-
ServiceCallback<void>
Обратный вызов
forceCloseHandles(string, Models.FileForceCloseHandlesOptionalParams)
Закрывает все дескрипторы, открытые для заданного файла
function forceCloseHandles(handleId: string, options?: Models.FileForceCloseHandlesOptionalParams)
Параметры
- handleId
-
string
Указывает идентификатор дескриптора, открытый в файле или каталоге для закрытия. Asterix ('*) — это подстановочный знак, указывающий все дескрипторы.
- options
- Models.FileForceCloseHandlesOptionalParams
Возвращаемое значение
Promise<Models.FileForceCloseHandlesResponse>
Обещание<Models.FileForceCloseHandlesResponse>
forceCloseHandles(string, ServiceCallback<void>)
function forceCloseHandles(handleId: string, callback: ServiceCallback<void>)
Параметры
- handleId
-
string
Указывает идентификатор дескриптора, открытый в файле или каталоге для закрытия. Asterix ('*) — это подстановочный знак, указывающий все дескрипторы.
- callback
-
ServiceCallback<void>
Обратный вызов
getProperties(FileGetPropertiesOptionalParams, ServiceCallback<void>)
function getProperties(options: FileGetPropertiesOptionalParams, callback: ServiceCallback<void>)
Параметры
- options
- FileGetPropertiesOptionalParams
Необязательные параметры
- callback
-
ServiceCallback<void>
Обратный вызов
getProperties(Models.FileGetPropertiesOptionalParams)
Возвращает все пользовательские метаданные, стандартные свойства HTTP и системные свойства файла. Он не возвращает содержимое файла.
function getProperties(options?: Models.FileGetPropertiesOptionalParams)
Параметры
- options
- Models.FileGetPropertiesOptionalParams
Возвращаемое значение
Promise<Models.FileGetPropertiesResponse>
Обещание<Models.FileGetPropertiesResponse>
getProperties(ServiceCallback<void>)
function getProperties(callback: ServiceCallback<void>)
Параметры
- callback
-
ServiceCallback<void>
Обратный вызов
getRangeList(FileGetRangeListOptionalParams, ServiceCallback<Range[]>)
function getRangeList(options: FileGetRangeListOptionalParams, callback: ServiceCallback<Range[]>)
Параметры
- options
- FileGetRangeListOptionalParams
Необязательные параметры
- callback
-
ServiceCallback<Range[]>
Обратный вызов
getRangeList(Models.FileGetRangeListOptionalParams)
Возвращает список допустимых диапазонов для файла.
function getRangeList(options?: Models.FileGetRangeListOptionalParams)
Параметры
- options
- Models.FileGetRangeListOptionalParams
Возвращаемое значение
Promise<Models.FileGetRangeListResponse>
Обещание<Models.FileGetRangeListResponse>
getRangeList(ServiceCallback<Range[]>)
function getRangeList(callback: ServiceCallback<Range[]>)
Параметры
- callback
-
ServiceCallback<Range[]>
Обратный вызов
listHandles(FileListHandlesOptionalParams, ServiceCallback<ListHandlesResponse>)
function listHandles(options: FileListHandlesOptionalParams, callback: ServiceCallback<ListHandlesResponse>)
Параметры
- options
- FileListHandlesOptionalParams
Необязательные параметры
- callback
-
ServiceCallback<ListHandlesResponse>
Обратный вызов
listHandles(Models.FileListHandlesOptionalParams)
Списки дескрипторов для файла
function listHandles(options?: Models.FileListHandlesOptionalParams)
Параметры
- options
- Models.FileListHandlesOptionalParams
Возвращаемое значение
Promise<Models.FileListHandlesResponse>
Обещание<Models.FileListHandlesResponse>
listHandles(ServiceCallback<ListHandlesResponse>)
function listHandles(callback: ServiceCallback<ListHandlesResponse>)
Параметры
- callback
-
ServiceCallback<ListHandlesResponse>
Обратный вызов
setHTTPHeaders(string, string, string, FileSetHTTPHeadersOptionalParams, ServiceCallback<void>)
function setHTTPHeaders(fileAttributes: string, fileCreationTime: string, fileLastWriteTime: string, options: FileSetHTTPHeadersOptionalParams, callback: ServiceCallback<void>)
Параметры
- fileAttributes
-
string
Если задано, указанные атрибуты файла должны быть заданы. Значение по умолчанию: "Архив" для файла и каталога. Значение "Нет" также можно указать как значение по умолчанию.
- fileCreationTime
-
string
Время создания файла или каталога.
- fileLastWriteTime
-
string
Время последней записи для файла или каталога.
- options
- FileSetHTTPHeadersOptionalParams
Необязательные параметры
- callback
-
ServiceCallback<void>
Обратный вызов
setHTTPHeaders(string, string, string, Models.FileSetHTTPHeadersOptionalParams)
Задает заголовки HTTP в файле.
function setHTTPHeaders(fileAttributes: string, fileCreationTime: string, fileLastWriteTime: string, options?: Models.FileSetHTTPHeadersOptionalParams)
Параметры
- fileAttributes
-
string
Если задано, указанные атрибуты файла должны быть заданы. Значение по умолчанию: "Архив" для файла и каталога. Значение "Нет" также можно указать как значение по умолчанию.
- fileCreationTime
-
string
Время создания файла или каталога.
- fileLastWriteTime
-
string
Время последней записи для файла или каталога.
- options
- Models.FileSetHTTPHeadersOptionalParams
Возвращаемое значение
Promise<Models.FileSetHTTPHeadersResponse>
Обещание<Models.FileSetHTTPHeadersResponse>
setHTTPHeaders(string, string, string, ServiceCallback<void>)
function setHTTPHeaders(fileAttributes: string, fileCreationTime: string, fileLastWriteTime: string, callback: ServiceCallback<void>)
Параметры
- fileAttributes
-
string
Если задано, указанные атрибуты файла должны быть заданы. Значение по умолчанию: "Архив" для файла и каталога. Значение "Нет" также можно указать как значение по умолчанию.
- fileCreationTime
-
string
Время создания файла или каталога.
- fileLastWriteTime
-
string
Время последней записи для файла или каталога.
- callback
-
ServiceCallback<void>
Обратный вызов
setMetadata(FileSetMetadataOptionalParams, ServiceCallback<void>)
function setMetadata(options: FileSetMetadataOptionalParams, callback: ServiceCallback<void>)
Параметры
- options
- FileSetMetadataOptionalParams
Необязательные параметры
- callback
-
ServiceCallback<void>
Обратный вызов
setMetadata(Models.FileSetMetadataOptionalParams)
Обновляет пользовательские метаданные для указанного файла.
function setMetadata(options?: Models.FileSetMetadataOptionalParams)
Параметры
- options
- Models.FileSetMetadataOptionalParams
Возвращаемое значение
Promise<Models.FileSetMetadataResponse>
Обещание<Models.FileSetMetadataResponse>
setMetadata(ServiceCallback<void>)
function setMetadata(callback: ServiceCallback<void>)
Параметры
- callback
-
ServiceCallback<void>
Обратный вызов
startCopy(string, FileStartCopyOptionalParams, ServiceCallback<void>)
function startCopy(copySource: string, options: FileStartCopyOptionalParams, callback: ServiceCallback<void>)
Параметры
- copySource
-
string
Указывает URL-адрес исходного файла или большого двоичного объекта до 2 КБ. Чтобы скопировать файл в другой файл в той же учетной записи хранения, можно использовать общий ключ для проверки подлинности исходного файла. Если вы копируете файл из другой учетной записи хранения или копируете большой двоичный объект из той же учетной записи хранения или другой учетной записи хранения, то необходимо пройти проверку подлинности исходного файла или большого двоичного объекта с помощью подписанного URL-адреса. Если источник является общедоступным BLOB-объектом, проверка подлинности не требуется для выполнения операции копирования. Файл в моментальном снимке общего ресурса также можно указать в качестве источника копирования.
- options
- FileStartCopyOptionalParams
Необязательные параметры
- callback
-
ServiceCallback<void>
Обратный вызов
startCopy(string, Models.FileStartCopyOptionalParams)
Копирует большой двоичный объект или файл в целевой файл в учетной записи хранения.
function startCopy(copySource: string, options?: Models.FileStartCopyOptionalParams)
Параметры
- copySource
-
string
Указывает URL-адрес исходного файла или большого двоичного объекта до 2 КБ. Чтобы скопировать файл в другой файл в той же учетной записи хранения, можно использовать общий ключ для проверки подлинности исходного файла. Если вы копируете файл из другой учетной записи хранения или копируете большой двоичный объект из той же учетной записи хранения или другой учетной записи хранения, то необходимо пройти проверку подлинности исходного файла или большого двоичного объекта с помощью подписанного URL-адреса. Если источник является общедоступным BLOB-объектом, проверка подлинности не требуется для выполнения операции копирования. Файл в моментальном снимке общего ресурса также можно указать в качестве источника копирования.
- options
- Models.FileStartCopyOptionalParams
Возвращаемое значение
Promise<Models.FileStartCopyResponse>
Обещание<Models.FileStartCopyResponse>
startCopy(string, ServiceCallback<void>)
function startCopy(copySource: string, callback: ServiceCallback<void>)
Параметры
- copySource
-
string
Указывает URL-адрес исходного файла или большого двоичного объекта до 2 КБ. Чтобы скопировать файл в другой файл в той же учетной записи хранения, можно использовать общий ключ для проверки подлинности исходного файла. Если вы копируете файл из другой учетной записи хранения или копируете большой двоичный объект из той же учетной записи хранения или другой учетной записи хранения, то необходимо пройти проверку подлинности исходного файла или большого двоичного объекта с помощью подписанного URL-адреса. Если источник является общедоступным BLOB-объектом, проверка подлинности не требуется для выполнения операции копирования. Файл в моментальном снимке общего ресурса также можно указать в качестве источника копирования.
- callback
-
ServiceCallback<void>
Обратный вызов
uploadRange(string, Models.FileRangeWriteType, number, FileUploadRangeOptionalParams, ServiceCallback<void>)
function uploadRange(range: string, fileRangeWrite: Models.FileRangeWriteType, contentLength: number, options: FileUploadRangeOptionalParams, callback: ServiceCallback<void>)
Параметры
- range
-
string
Указывает диапазон записываемых байтов. Необходимо указать начало и конец диапазона. Для операции обновления диапазон может быть размером до 4 МБ. Для четкой операции диапазон может быть до значения полного размера файла. Служба файлов принимает только один диапазон байтов для заголовков Range и x-ms-range, а диапазон байтов должен быть указан в следующем формате: bytes=startByte-endByte.
- fileRangeWrite
- Models.FileRangeWriteType
Укажите один из следующих параметров: обновление: записывает байты, указанные текстом запроса, в указанный диапазон. Заголовки Range и Content-Length должны соответствовать выполнению обновления. — Очистить: очищает указанный диапазон и освобождает пространство, используемое в хранилище для этого диапазона. Чтобы очистить диапазон, задайте заголовок Content-Length равным нулю, а заголовок Range — значение, указывающее, что диапазон очищается до максимального размера файла. Возможные значения: "update", "clear"
- contentLength
-
number
Указывает количество байтов, передаваемых в тексте запроса. Если заголовок x-ms-write установлен для очистки, значение этого заголовка должно быть равно нулю.
- options
- FileUploadRangeOptionalParams
Необязательные параметры
- callback
-
ServiceCallback<void>
Обратный вызов
uploadRange(string, Models.FileRangeWriteType, number, Models.FileUploadRangeOptionalParams)
Отправьте диапазон байтов в файл.
function uploadRange(range: string, fileRangeWrite: Models.FileRangeWriteType, contentLength: number, options?: Models.FileUploadRangeOptionalParams)
Параметры
- range
-
string
Указывает диапазон записываемых байтов. Необходимо указать начало и конец диапазона. Для операции обновления диапазон может быть размером до 4 МБ. Для четкой операции диапазон может быть до значения полного размера файла. Служба файлов принимает только один диапазон байтов для заголовков Range и x-ms-range, а диапазон байтов должен быть указан в следующем формате: bytes=startByte-endByte.
- fileRangeWrite
- Models.FileRangeWriteType
Укажите один из следующих параметров: обновление: записывает байты, указанные текстом запроса, в указанный диапазон. Заголовки Range и Content-Length должны соответствовать выполнению обновления. — Очистить: очищает указанный диапазон и освобождает пространство, используемое в хранилище для этого диапазона. Чтобы очистить диапазон, задайте заголовок Content-Length равным нулю, а заголовок Range — значение, указывающее, что диапазон очищается до максимального размера файла. Возможные значения: "update", "clear"
- contentLength
-
number
Указывает количество байтов, передаваемых в тексте запроса. Если заголовок x-ms-write установлен для очистки, значение этого заголовка должно быть равно нулю.
- options
- Models.FileUploadRangeOptionalParams
Возвращаемое значение
Promise<Models.FileUploadRangeResponse>
Обещание<Models.FileUploadRangeResponse>
uploadRange(string, Models.FileRangeWriteType, number, ServiceCallback<void>)
function uploadRange(range: string, fileRangeWrite: Models.FileRangeWriteType, contentLength: number, callback: ServiceCallback<void>)
Параметры
- range
-
string
Указывает диапазон записываемых байтов. Необходимо указать начало и конец диапазона. Для операции обновления диапазон может быть размером до 4 МБ. Для четкой операции диапазон может быть до значения полного размера файла. Служба файлов принимает только один диапазон байтов для заголовков Range и x-ms-range, а диапазон байтов должен быть указан в следующем формате: bytes=startByte-endByte.
- fileRangeWrite
- Models.FileRangeWriteType
Укажите один из следующих параметров: обновление: записывает байты, указанные текстом запроса, в указанный диапазон. Заголовки Range и Content-Length должны соответствовать выполнению обновления. — Очистить: очищает указанный диапазон и освобождает пространство, используемое в хранилище для этого диапазона. Чтобы очистить диапазон, задайте заголовок Content-Length равным нулю, а заголовок Range — значение, указывающее, что диапазон очищается до максимального размера файла. Возможные значения: "update", "clear"
- contentLength
-
number
Указывает количество байтов, передаваемых в тексте запроса. Если заголовок x-ms-write установлен для очистки, значение этого заголовка должно быть равно нулю.
- callback
-
ServiceCallback<void>
Обратный вызов
uploadRangeFromURL(string, string, string, number, FileUploadRangeFromURLOptionalParams, ServiceCallback<void>)
function uploadRangeFromURL(range: string, copySource: string, sourceRange: string, contentLength: number, options: FileUploadRangeFromURLOptionalParams, callback: ServiceCallback<void>)
Параметры
- range
-
string
Записывает данные в указанный диапазон байтов в файле.
- copySource
-
string
Указывает URL-адрес исходного файла или большого двоичного объекта до 2 КБ. Чтобы скопировать файл в другой файл в той же учетной записи хранения, можно использовать общий ключ для проверки подлинности исходного файла. Если вы копируете файл из другой учетной записи хранения или копируете большой двоичный объект из той же учетной записи хранения или другой учетной записи хранения, то необходимо пройти проверку подлинности исходного файла или большого двоичного объекта с помощью подписанного URL-адреса. Если источник является общедоступным BLOB-объектом, проверка подлинности не требуется для выполнения операции копирования. Файл в моментальном снимке общего ресурса также можно указать в качестве источника копирования.
- sourceRange
-
string
Байты исходных данных в указанном диапазоне.
- contentLength
-
number
Указывает количество байтов, передаваемых в тексте запроса. Если заголовок x-ms-write установлен для очистки, значение этого заголовка должно быть равно нулю.
Необязательные параметры
- callback
-
ServiceCallback<void>
Обратный вызов
uploadRangeFromURL(string, string, string, number, Models.FileUploadRangeFromURLOptionalParams)
Отправьте диапазон байтов в файл, в котором содержимое считываются из URL-адреса.
function uploadRangeFromURL(range: string, copySource: string, sourceRange: string, contentLength: number, options?: Models.FileUploadRangeFromURLOptionalParams)
Параметры
- range
-
string
Записывает данные в указанный диапазон байтов в файле.
- copySource
-
string
Указывает URL-адрес исходного файла или большого двоичного объекта до 2 КБ. Чтобы скопировать файл в другой файл в той же учетной записи хранения, можно использовать общий ключ для проверки подлинности исходного файла. Если вы копируете файл из другой учетной записи хранения или копируете большой двоичный объект из той же учетной записи хранения или другой учетной записи хранения, то необходимо пройти проверку подлинности исходного файла или большого двоичного объекта с помощью подписанного URL-адреса. Если источник является общедоступным BLOB-объектом, проверка подлинности не требуется для выполнения операции копирования. Файл в моментальном снимке общего ресурса также можно указать в качестве источника копирования.
- sourceRange
-
string
Байты исходных данных в указанном диапазоне.
- contentLength
-
number
Указывает количество байтов, передаваемых в тексте запроса. Если заголовок x-ms-write установлен для очистки, значение этого заголовка должно быть равно нулю.
- options
- Models.FileUploadRangeFromURLOptionalParams
Возвращаемое значение
Promise<Models.FileUploadRangeFromURLResponse>
Обещание<Models.FileUploadRangeFromURLResponse>
uploadRangeFromURL(string, string, string, number, ServiceCallback<void>)
function uploadRangeFromURL(range: string, copySource: string, sourceRange: string, contentLength: number, callback: ServiceCallback<void>)
Параметры
- range
-
string
Записывает данные в указанный диапазон байтов в файле.
- copySource
-
string
Указывает URL-адрес исходного файла или большого двоичного объекта до 2 КБ. Чтобы скопировать файл в другой файл в той же учетной записи хранения, можно использовать общий ключ для проверки подлинности исходного файла. Если вы копируете файл из другой учетной записи хранения или копируете большой двоичный объект из той же учетной записи хранения или другой учетной записи хранения, то необходимо пройти проверку подлинности исходного файла или большого двоичного объекта с помощью подписанного URL-адреса. Если источник является общедоступным BLOB-объектом, проверка подлинности не требуется для выполнения операции копирования. Файл в моментальном снимке общего ресурса также можно указать в качестве источника копирования.
- sourceRange
-
string
Байты исходных данных в указанном диапазоне.
- contentLength
-
number
Указывает количество байтов, передаваемых в тексте запроса. Если заголовок x-ms-write установлен для очистки, значение этого заголовка должно быть равно нулю.
- callback
-
ServiceCallback<void>
Обратный вызов