ShareFileClient class

Создает экземпляр ShareFileClient.

new ShareFileClient(url: string, credential?: Credential | TokenCredential, options?: ShareClientOptions)

Параметры

Создает экземпляр ShareFileClient.

new ShareFileClient(url: string, pipeline: Pipeline, options?: ShareClientConfig)

Параметры

Имя файла

string name

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

Полный путь к файлу

string path

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

Имя общей папки, соответствующее этому клиенту файла

string shareName

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

accountName: string

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

наследуется от storageClient.accountName

Значение строки URL-адреса.

url: string

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

наследуется от StorageClient.url

Прервана ожидающая операция копирования файла и оставляет целевой файл с нулевой длиной и полными метаданными.

См. https://learn.microsoft.com/rest/api/storageservices/abort-copy-file

function abortCopyFromURL(copyId: string, options?: FileAbortCopyFromURLOptions): Promise<FileAbortCopyResponse>

Параметры

Возвращаемое значение

Очищает указанный диапазон и освобождает пространство, используемое в хранилище для этого диапазона.

function clearRange(offset: number, contentLength: number, options?: FileClearRangeOptions): Promise<FileUploadRangeResponse>

Параметры

Возвращаемое значение

Создает новый файл или заменяет файл. Обратите внимание, что файл инициализируется только без содержимого.

См. https://learn.microsoft.com/rest/api/storageservices/create-file

function create(size: number, options?: FileCreateOptions): Promise<FileCreateResponse>

Параметры

Возвращаемое значение

Ответные данные для операции создания файла.

Пример использования:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareName = "<share name>";
const directoryName = "<directory name>";
const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);

const content = "Hello World!";
const fileName = `newdirectory${+new Date()}`;
const fileClient = directoryClient.getFileClient(fileName);
await fileClient.create(content.length);
console.log(`Create file ${fileName} successfully`);

// Upload file range
await fileClient.uploadRange(content, 0, content.length);
console.log(`Upload file range "${content}" to ${fileName} successfully`);

Только NFS. Создает жесткую ссылку на файл, указанный по пути.

function createHardLink(targetFile: string, options?: FileCreateHardLinkOptions): Promise<FileCreateHardLinkResponse>

Параметры

Возвращаемое значение

Только NFS. Создает символьную ссылку.

function createSymbolicLink(linkText: string, options?: FileCreateSymbolicLinkOptions): Promise<FileCreateSymbolicLinkResponse>

Параметры

Возвращаемое значение

Удаляет файл из учетной записи хранения. При успешном удалении файла он немедленно удаляется из индекса учетной записи хранения и больше недоступен клиентам. Данные файла позже удаляются из службы во время сборки мусора.

Удаление файла завершится ошибкой с кодом состояния 409 (конфликт) и кодом ошибки ShareViolation, если файл открыт на клиенте SMB.

Удаление файла не поддерживается в моментальном снимке общего ресурса, который является копией общего ресурса только для чтения. Попытка выполнить эту операцию на моментальном снимке общего ресурса завершится ошибкой 400 (InvalidQueryParameterValue)

См. https://learn.microsoft.com/rest/api/storageservices/delete-file2

function delete(options?: FileDeleteOptions): Promise<FileDeleteResponse>

Параметры

Возвращаемое значение

Ответные данные для операции удаления файла.

Удаляет файл из учетной записи хранения, если она существует. При успешном удалении файла он немедленно удаляется из индекса учетной записи хранения и больше недоступен клиентам. Данные файла позже удаляются из службы во время сборки мусора.

Удаление файла завершится ошибкой с кодом состояния 409 (конфликт) и кодом ошибки ShareViolation, если файл открыт на клиенте SMB.

Удаление файла не поддерживается в моментальном снимке общего ресурса, который является копией общего ресурса только для чтения. Попытка выполнить эту операцию на моментальном снимке общего ресурса завершится ошибкой 400 (InvalidQueryParameterValue)

См. https://learn.microsoft.com/rest/api/storageservices/delete-file2

function deleteIfExists(options?: FileDeleteOptions): Promise<FileDeleteIfExistsResponse>

Параметры

Возвращаемое значение

Считывает или загружает файл из системы, включая его метаданные и свойства.

• В Node.jsданные возвращаются в потоке для чтения readableStreamBody
• В браузерах данные возвращаются в contentAsBlob обещания

См. https://learn.microsoft.com/rest/api/storageservices/get-file

function download(offset?: number, count?: number, options?: FileDownloadOptions): Promise<FileDownloadResponseModel>

Параметры

Возвращаемое значение

Ответные данные для операции скачивания файлов.

Пример использования (Node.js):

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareName = "<share name>";
const fileName = "<file name>";
const fileClient = serviceClient
  .getShareClient(shareName)
  .rootDirectoryClient.getFileClient(fileName);

// Get file content from position 0 to the end
// In Node.js, get downloaded data by accessing downloadFileResponse.readableStreamBody
const downloadFileResponse = await fileClient.download();
if (downloadFileResponse.readableStreamBody) {
  const buffer = await streamToBuffer(downloadFileResponse.readableStreamBody);
  console.log(`Downloaded file content: ${buffer.toString()}`);
}

// [Node.js only] A helper method used to read a Node.js readable stream into a Buffer
async function streamToBuffer(readableStream: NodeJS.ReadableStream): Promise<Buffer> {
  return new Promise((resolve, reject) => {
    const chunks: Buffer[] = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

Пример использования (браузеры):

import { ShareServiceClient } from "@azure/storage-file-share";

const account = "<account name>";
const sas = "<service Shared Access Signature Token>";

const serviceClient = new ShareServiceClient(`https://${account}.file.core.windows.net?${sas}`);

const shareName = "<share name>";
const fileName = "<file name>";
const fileClient = serviceClient
  .getShareClient(shareName)
  .rootDirectoryClient.getFileClient(fileName);

// Get file content from position 0 to the end
// In browsers, get downloaded data by accessing downloadFileResponse.blobBody
const downloadFileResponse = await fileClient.download(0);
if (downloadFileResponse.blobBody) {
  console.log(`Downloaded file content: ${(await downloadFileResponse.blobBody).text()}`);
}

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Загружает файл Azure параллельно с буфером. Смещение и число являются необязательными, передайте 0 для скачивания всего файла.

Предупреждение. Буферы могут поддерживать только файлы до одного гигабайта в 32-разрядных системах или около двух гигабайтов в 64-разрядных системах из-за ограничений Node.js/V8. Для файлов, превышающих этот размер, рекомендуется downloadToFile.

function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: FileDownloadToBufferOptions): Promise<Buffer>

Параметры

Возвращаемое значение

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS

Загружает файл Azure параллельно с буфером. Смещение и количество необязательными, передайте 0 для скачивания всего файла.

Предупреждение. Буферы могут поддерживать только файлы до одного гигабайта в 32-разрядных системах или около двух гигабайтов в 64-разрядных системах из-за ограничений Node.js/V8. Для файлов, превышающих этот размер, рекомендуется downloadToFile.

function downloadToBuffer(offset?: number, count?: number, options?: FileDownloadToBufferOptions): Promise<Buffer>

Параметры

Возвращаемое значение

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Загружает большой двоичный объект Azure в локальный файл. Завершается ошибкой, если указанный путь к файлу уже завершается. Смещение и число являются необязательными, передайте 0 и не определено соответственно, чтобы скачать весь большой двоичный объект.

function downloadToFile(filePath: string, offset?: number, count?: number, options?: FileDownloadOptions): Promise<FileDownloadResponseModel>

Параметры

Возвращаемое значение

Данные отклика для операции скачивания BLOB-объектов, но при использовании readableStreamBody установлено значение undefined, так как его содержимое уже считывается и записывается в локальный файл по указанному пути.

Возвращает значение true, если указанный файл существует; False в противном случае.

ПРИМЕЧАНИЕ. Используйте эту функцию с осторожностью, так как существующий файл может быть удален другими клиентами или приложениями. Наоборот, новые файлы могут быть добавлены другими клиентами или приложениями после завершения этой функции.

function exists(options?: FileExistsOptions): Promise<boolean>

Параметры

Возвращаемое значение

Принудительно закройте все дескрипторы для файла.

См. https://learn.microsoft.com/rest/api/storageservices/force-close-handles

function forceCloseAllHandles(options?: FileForceCloseHandlesOptions): Promise<CloseHandlesInfo>

Параметры

Возвращаемое значение

Принудительно закройте определенный дескриптор для файла.

См. https://learn.microsoft.com/rest/api/storageservices/force-close-handles

function forceCloseHandle(handleId: string, options?: FileForceCloseHandlesOptions): Promise<FileForceCloseHandlesResponse>

Параметры

Возвращаемое значение

Доступно только для клиентов, созданных с использованием учетных данных общего ключа.

Создает строку для входа в универсальный код ресурса (SAS) службы на основе свойств и параметров клиента, переданных. SAS подписан учетными данными общего ключа клиента.

См. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

Параметры

Возвращаемое значение

URI SAS, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

Доступно только для клиентов, созданных с использованием учетных данных общего ключа.

Создает универсальный код ресурса (SAS) подписанного URL-адреса службы на основе свойств и параметров клиента, переданных. SAS подписан учетными данными общего ключа клиента.

См. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: FileGenerateSasUrlOptions): string

Параметры

Возвращаемое значение

URI SAS, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

Возвращает все пользовательские метаданные, стандартные свойства HTTP и системные свойства файла. Он не возвращает содержимое файла.

См. https://learn.microsoft.com/rest/api/storageservices/get-file-properties

function getProperties(options?: FileGetPropertiesOptions): Promise<FileGetPropertiesResponse>

Параметры

Возвращаемое значение

Ответные данные для операции получения свойств файла.

Возвращает список допустимых диапазонов для файла.

function getRangeList(options?: FileGetRangeListOptions): Promise<FileGetRangeListResponse>

Параметры

Возвращаемое значение

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

function getRangeListDiff(prevShareSnapshot: string, options?: FileGetRangeListOptions): Promise<FileGetRangeListDiffResponse>

Параметры

Возвращаемое значение

Получите ShareLeaseClient, которая управляет арендой файла.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Параметры

Возвращаемое значение

Новый объект ShareLeaseClient для управления арендами файла.

Только NFS. Получает содержимое символьной ссылки.

function getSymbolicLink(options?: FileGetSymbolicLinkOptions): Promise<FileGetSymbolicLinkResponse>

Параметры

Возвращаемое значение

Возвращает асинхронный итератор для перечисления всех дескрипторов. под указанной учетной записью.

.byPage() возвращает асинхронный итератор для перечисления дескрипторов на страницах.

function listHandles(options?: FileListHandlesOptions): PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse, PageSettings>

Параметры

Возвращаемое значение

Переименовывает файл. Этот API поддерживает переименование файла в той же общей папке.

function rename(destinationPath: string, options?: FileRenameOptions): Promise<{ destinationFileClient: ShareFileClient, fileRenameResponse: FileRenameResponse }>

Параметры

Возвращаемое значение

Ответные данные для операции переименования файла.

Пример использования:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareName = "<share name>";
const directoryName = "<directory name>";
const fileName = "<file name>";
const destinationPath = "<destination path>";
const fileClient = serviceClient
  .getShareClient(shareName)
  .getDirectoryClient(directoryName)
  .getFileClient(fileName);

await fileClient.rename(destinationPath);

Изменение размера файла.

См. https://learn.microsoft.com/rest/api/storageservices/set-file-properties

function resize(length: number, options?: FileResizeOptions): Promise<FileSetHTTPHeadersResponse>

Параметры

Возвращаемое значение

Ответные данные для операции заголовков HTTP набора файлов.

Задает заголовки HTTP в файле.

Если параметр не указан или нет значения, указанного для заголовков HTTP файла в параметрах, эти заголовки HTTP-файла без значения будут удалены.

См. https://learn.microsoft.com/rest/api/storageservices/set-file-properties

function setHttpHeaders(fileHttpHeaders?: FileHttpHeaders, options?: FileSetHttpHeadersOptions): Promise<FileSetHTTPHeadersResponse>

Параметры

Возвращаемое значение

Ответные данные для операции заголовков HTTP набора файлов.

Обновляет пользовательские метаданные для указанного файла.

Если метаданные не определены в параметре параметра, метаданные файла будут удалены.

См. https://learn.microsoft.com/rest/api/storageservices/set-file-metadata

function setMetadata(metadata?: Metadata, options?: FileSetMetadataOptions): Promise<FileSetMetadataResponse>

Параметры

Возвращаемое значение

Ответные данные для операции метаданных набора файлов.

Задает свойства в файле.

См. https://learn.microsoft.com/rest/api/storageservices/set-file-properties

function setProperties(properties?: FileProperties): Promise<SetPropertiesResponse>

Параметры

Возвращаемое значение

Копирует большой двоичный объект или файл в целевой файл в учетной записи хранения.

function startCopyFromURL(copySource: string, options?: FileStartCopyOptions): Promise<FileStartCopyResponse>

Параметры

Возвращаемое значение

Создает новый файл Azure или заменяет существующий файл Azure, а затем отправляет в него файл Buffer(Node)/Blob/ArrayBuffer/ArrayBufferView.

function uploadData(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: FileParallelUploadOptions): Promise<void>

Параметры

Возвращаемое значение

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Создает новый файл Azure или заменяет существующий файл Azure, а затем отправляет в него локальный файл.

function uploadFile(filePath: string, options?: FileParallelUploadOptions): Promise<void>

Параметры

Возвращаемое значение

Отправьте диапазон байтов в файл. Эта операция может вызываться только в существующем файле. Он не изменит размер, свойства или метаданные файла. Необходимо указать как начальный, так и счетчик диапазона. Диапазон может быть размером до 4 МБ.

function uploadRange(body: RequestBodyType, offset: number, contentLength: number, options?: FileUploadRangeOptions): Promise<FileUploadRangeResponse>

Параметры

Возвращаемое значение

Ответные данные для операции "Диапазон отправки файлов".

Пример использования:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareName = "<share name>";
const directoryName = "<directory name>";
const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);

const content = "Hello World!";
const fileName = `newdirectory${+new Date()}`;
const fileClient = directoryClient.getFileClient(fileName);
await fileClient.create(content.length);
console.log(`Create file ${fileName} successfully`);

// Upload file range
await fileClient.uploadRange(content, 0, content.length);
console.log(`Upload file range "${content}" to ${fileName} successfully`);

Отправьте диапазон байтов в файл, где содержимое считываются из URL-адреса другого файла. Диапазон может быть размером до 4 МБ.

function uploadRangeFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: FileUploadRangeFromURLOptions): Promise<FileUploadRangeFromURLResponse>

Параметры

Возвращаемое значение

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Принимает Node.js читаемую фабрику потоков и отправляет в блоки в файл Azure. Фабрика потоков с возможностью чтения должна возвращать Node.js доступный для чтения поток, начиная с определенного смещения. Смещение — это смещение в файле Azure для отправки.

function uploadResetableStream(streamFactory: (offset: number, count?: number) => ReadableStream, size: number, options?: FileParallelUploadOptions): Promise<void>

Параметры

Возвращаемое значение

ДОСТУПНО ТОЛЬКО В БРАУЗЕРАХ.

Отправляет объект BLOB-объекта браузера в файл Azure. Требуется blobFactory в качестве источника данных, который должен возвращать объект BLOB-объекта со смещением и размером, предоставленным.

function uploadSeekableBlob(blobFactory: (offset: number, size: number) => Blob, size: number, options?: FileParallelUploadOptions): Promise<void>

Параметры

Возвращаемое значение

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Создает новый файл Azure или заменяет существующий файл Azure, а затем отправляет в него Node.js доступный для чтения поток. Этот метод попытается создать файл Azure, а затем начнет отправлять блоки по блоку. Размер блока определяется параметром bufferSize. Убедитесь, что потенциальный размер потока не превышает размер файла.

СОВЕТЫ ПО УЛУЧШЕНИЮ ПРОИЗВОДИТЕЛЬНОСТИ:

• Входной поток highWaterMark лучше задать то же значение с параметром bufferSize, что позволит избежать операций Buffer.concat().

function uploadStream(stream: Readable, size: number, bufferSize: number, maxBuffers: number, options?: FileUploadStreamOptions): Promise<void>

Параметры

Возвращаемое значение

Создает новый объект ShareFileClient, идентичный источнику, но с указанной меткой времени моментального снимка общего ресурса. Укажите "" удаляет моментальный снимок и возвращает URL-адрес базового ShareFileClient.

function withShareSnapshot(shareSnapshot: string): ShareFileClient

Параметры

Возвращаемое значение

Новый объект ShareFileClient идентичен источнику, но с указанной меткой времени моментального снимка общего ресурса.