Aracılığıyla paylaş


ShareFileClient class

ShareFileClient, Bir Azure Depolama dosyasının URL'sini temsil eder.

Extends

StorageClient

Oluşturucular

ShareFileClient(string, Credential | TokenCredential, ShareClientOptions)

ShareFileClient örneği oluşturur.

ShareFileClient(string, Pipeline, ShareClientConfig)

ShareFileClient örneği oluşturur.

Özellikler

name

Dosyanın adı

path

Dosyanın tam yolu

shareName

Bu dosya istemcisine karşılık gelen paylaşım adı

Devralınan Özellikler

accountName
url

URL dizesi değeri.

Yöntemler

abortCopyFromURL(string, FileAbortCopyFromURLOptions)

Bekleyen Bir Dosya Kopyalama işlemini durdurur ve hedef dosyayı sıfır uzunlukta ve tam meta veriyle bırakır.

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

clearRange(number, number, FileClearRangeOptions)

Belirtilen aralığı temizler ve bu aralık için depolamada kullanılan alanı serbest bırakır.

create(number, FileCreateOptions)

Yeni bir dosya oluşturur veya bir dosyanın yerini alır. Yalnızca içeriği olmayan dosyayı başlatdığını unutmayın.

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

createHardLink(string, FileCreateHardLinkOptions)

Yalnızca NFS. Yol tarafından belirtilen dosya dosyasına sabit bir bağlantı oluşturur.

createSymbolicLink(string, FileCreateSymbolicLinkOptions)

Yalnızca NFS. Sembolik bir bağlantı oluşturur.

delete(FileDeleteOptions)

Dosyayı depolama hesabından kaldırır. Bir dosya başarıyla silindiğinde, depolama hesabının dizininden hemen kaldırılır ve artık istemciler tarafından erişilemez. Dosyanın verileri daha sonra çöp toplama sırasında hizmetten kaldırılır.

Silme Dosyası, SMB istemcisinde açıksa 409 (Çakışma) durum kodu ve SharingViolation hata koduyla başarısız olur.

Dosya Sil, paylaşımın salt okunur bir kopyası olan paylaşım anlık görüntüsünde desteklenmez. Paylaşım anlık görüntüsünde bu işlemi gerçekleştirme girişimi 400 (InvalidQueryParameterValue) ile başarısız olur

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

deleteIfExists(FileDeleteOptions)

Varsa dosyayı depolama hesabından kaldırır. Bir dosya başarıyla silindiğinde, depolama hesabının dizininden hemen kaldırılır ve artık istemciler tarafından erişilemez. Dosyanın verileri daha sonra çöp toplama sırasında hizmetten kaldırılır.

Silme Dosyası, SMB istemcisinde açıksa 409 (Çakışma) durum kodu ve SharingViolation hata koduyla başarısız olur.

Dosya Sil, paylaşımın salt okunur bir kopyası olan paylaşım anlık görüntüsünde desteklenmez. Paylaşım anlık görüntüsünde bu işlemi gerçekleştirme girişimi 400 (InvalidQueryParameterValue) ile başarısız olur

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

download(number, number, FileDownloadOptions)

Meta verileri ve özellikleri dahil olmak üzere sistemden bir dosyayı okur veya indirir.

  • Node.js'de veriler Okunabilir bir akış readableStreamBody
  • Tarayıcılarda veriler bir promise contentAsBlob

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

downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Arabelleğe paralel olarak bir Azure dosyası indirir. Uzaklık ve sayı isteğe bağlıdır, her ikisi için de 0 geçirerek dosyanın tamamını indirin.

Uyarı: Arabellekler, Node.js/V8 sınırlamaları nedeniyle 32 bit sistemlerde yaklaşık bir gigabayt veya 64 bit sistemlerde yaklaşık iki gigabayt kadar dosyaları destekleyebilir. Bu boyuttan daha büyük dosyalar için downloadToFilegöz önünde bulundurun.

downloadToBuffer(number, number, FileDownloadToBufferOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR

Arabelleğe paralel olarak bir Azure dosyası indirir. Uzaklık ve sayı isteğe bağlıdır, her ikisi için de 0 geçirerek dosyanın tamamını indirin

Uyarı: Arabellekler, Node.js/V8 sınırlamaları nedeniyle 32 bit sistemlerde yaklaşık bir gigabayt veya 64 bit sistemlerde yaklaşık iki gigabayt kadar dosyaları destekleyebilir. Bu boyuttan daha büyük dosyalar için downloadToFilegöz önünde bulundurun.

downloadToFile(string, number, number, FileDownloadOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Azure Blob'ları yerel bir dosyaya indirir. Verilen dosya yolu zaten çıkarsa başarısız olur. Uzaklık ve sayı isteğe bağlıdır, blob'un tamamını indirmek için sırasıyla 0 ve undefined değerini geçirir.

exists(FileExistsOptions)

Belirtilen dosya varsa true döndürür; false olarak ayarlayın.

NOT: Mevcut bir dosya diğer istemciler veya uygulamalar tarafından silinebileceğinden bu işlevi dikkatli kullanın. Bu işlev tamamlandıktan sonra diğer istemciler veya uygulamalar tarafından yeni dosyalar eklenebilir.

forceCloseAllHandles(FileForceCloseHandlesOptions)

Bir dosyanın tüm tanıtıcılarını zorla kapatın.

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

forceCloseHandle(string, FileForceCloseHandlesOptions)

Bir dosya için belirli bir tanıtıcıyı kapatmaya zorlar.

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

generateSasStringToSign(FileGenerateSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle inşa edilen istemciler için kullanılabilir.

Geçirilen istemci özelliklerine ve parametrelerine göre Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini imzalamak için dize oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır.

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

generateSasUrl(FileGenerateSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle inşa edilen istemciler için kullanılabilir.

geçirilen istemci özelliklerine ve parametrelerine göre bir Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır.

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

generateUserDelegationSasUrl(ShareGenerateSasUrlOptions, UserDelegationKey)

geçirilen istemci özelliklerine ve parametrelerine göre bir Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, kullanıcı delegasyonu anahtarı kimlik bilgisi girişiyle imzalanır.

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

generateUserDelegationStringToSign(ShareGenerateSasUrlOptions, UserDelegationKey)

geçirilen istemci özelliklerine ve parametrelerine göre bir Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, kullanıcı delegasyonu anahtarı kimlik bilgisi girişiyle imzalanır.

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

getProperties(FileGetPropertiesOptions)

Dosya için tüm kullanıcı tanımlı meta verileri, standart HTTP özelliklerini ve sistem özelliklerini döndürür. Dosyanın içeriğini döndürmez.

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

getRangeList(FileGetRangeListOptions)

Bir dosya için geçerli aralıkların listesini döndürür.

getRangeListDiff(string, FileGetRangeListOptions)

Önceki paylaşım anlık görüntüsüyle bu dosya arasında farklılık gösteren aralıkların listesini döndürür.

getShareLeaseClient(string)

Dosyadaki kiraları yöneten bir ShareLeaseClient alın.

getSymbolicLink(FileGetSymbolicLinkOptions)

Yalnızca NFS. Sembolik bir bağlantının içeriğini alır.

listHandles(FileListHandlesOptions)

Tüm tanıtıcıları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür. öğesini seçin.

.byPage() sayfalardaki tanıtıcıları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

rename(string, FileRenameOptions)

Dosyayı yeniden adlandırır. Bu API yalnızca aynı paylaşımdaki bir dosyanın yeniden adlandırılabilmesini destekler.

resize(number, FileResizeOptions)

Dosyayı yeniden boyutlandırın.

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

setHttpHeaders(FileHttpHeaders, FileSetHttpHeadersOptions)

Dosyada HTTP üst bilgilerini ayarlar.

Seçenek sağlanmadıysa veya seçeneklerdeki dosya HTTP üst bilgileri için değer sağlanmadıysa, bu dosya HTTP üst bilgileri bir değer olmadan temizlenir.

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

setMetadata(Metadata, FileSetMetadataOptions)

Belirtilen dosya için kullanıcı tanımlı meta verileri güncelleştirir.

seçenek parametresinde tanımlı meta veri yoksa, dosya meta verileri kaldırılır.

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

setProperties(FileProperties)

Dosyadaki özellikleri ayarlar.

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

startCopyFromURL(string, FileStartCopyOptions)

Bir blobu veya dosyayı depolama hesabındaki hedef dosyaya kopyalar.

uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, FileParallelUploadOptions)

Yeni bir Azure Dosyası oluşturur veya var olan bir Azure Dosyasının yerini alır ve ardından bir Buffer(Node)/Blob/ArrayBuffer/ArrayBufferView yükler.

uploadFile(string, FileParallelUploadOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Yeni bir Azure Dosyası oluşturur veya mevcut bir Azure Dosyasının yerini alır ve ardından yerel bir dosyayı bu dosyaya yükler.

uploadRange(RequestBodyType, number, number, FileUploadRangeOptions)

Dosyaya bir bayt aralığı yükleyin. Bu işlem yalnızca mevcut bir dosyada çağrılabilir. Dosyanın boyutunu, özelliklerini veya meta verilerini değiştirmez. Aralığın hem başlangıcı hem de sayısı belirtilmelidir. Aralığın boyutu 4 MB'a kadar olabilir.

uploadRangeFromURL(string, number, number, number, FileUploadRangeFromURLOptions)

İçeriğin başka bir dosyanın URL'sinden okunduğu bir dosyaya bir bayt aralığı yükleyin. Aralığın boyutu 4 MB'a kadar olabilir.

uploadResetableStream((offset: number, count?: number) => ReadableStream, number, FileParallelUploadOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Node.js Okunabilir akış fabrikasını kabul eder ve bloklar halinde bir Azure Dosyasına yükler. Okunabilir akış fabrikası, tanımlanan uzaklıktan başlayarak Node.js Okunabilir bir akış döndürmelidir. Uzaklık, karşıya yüklenecek Azure dosyasındaki uzaklıktır.

uploadSeekableBlob((offset: number, size: number) => Blob, number, FileParallelUploadOptions)

YALNıZCA TARAYıCıLARDA KULLANıLABILIR.

Tarayıcı Blob nesnesini bir Azure dosyasına yükler. Veri kaynağı olarak bir blobFactory gerektirir ve bu da sağlanan uzaklık ve boyuta sahip bir Blob nesnesi döndürmesi gerekir.

uploadStream(Readable, number, number, number, FileUploadStreamOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Yeni bir Azure Dosyası oluşturur veya mevcut bir Azure Dosyasının yerini alır ve ardından Node.js Okunabilir bir akışı bu dosyaya yükler. Bu yöntem bir Azure Dosyası oluşturmaya çalışır ve öbekleri öbek olarak karşıya yüklemeye başlar. Öbek boyutu bufferSize parametresiyle tanımlanır. Lütfen olası akış boyutunun dosya boyutunu aşmadığından emin olun.

PERFORMANS GELIŞTIRME IPUÇLARı:

  • Giriş akışı highWaterMark, Buffer.concat() işlemlerinden kaçınacak bufferSize parametresiyle aynı değeri ayarlamak daha iyidir.
withShareSnapshot(string)

Kaynakla aynı ancak belirtilen paylaşım anlık görüntüsü zaman damgasıyla yeni bir ShareFileClient nesnesi oluşturur. "" değerini sağlayın, anlık görüntüyü kaldırır ve temel ShareFileClient url'sine bir URL döndürür.

Oluşturucu Ayrıntıları

ShareFileClient(string, Credential | TokenCredential, ShareClientOptions)

ShareFileClient örneği oluşturur.

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

Parametreler

url

string

Azure Depolama dosyasına işaret eden "https://myaccount.file.core.windows.net/myshare/mydirectory/file" gibi bir URL dizesi. AnonymousCredential kullanıyorsanız , "https://myaccount.file.core.windows.net/myshare/mydirectory/file?sasString" gibi bir SAS ekleyebilirsiniz. Bu yöntem, bir dosyaya işaret eden kodlanmış bir URL'yi veya kodlanmamış URL'yi kabul eder. Kodlanmış URL dizesi iki kez kaçılmaz, YALNıZCA URL yolundaki özel karakterlerden kaçılır. Ancak, bir dosya veya dizin adı %içeriyorsa, dosya veya dizin adı URL'de kodlanmalıdır. "myfile%" adlı bir dosya gibi, URL "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25" olmalıdır.

credential

Credential | TokenCredential

Gibi, StorageSharedKeyCredential veya TokenCredential, Belirtilmezse, AnonymousCredential kullanılır.

options
ShareClientOptions

Optional. HTTP işlem hattını yapılandırma seçenekleri.

ShareFileClient(string, Pipeline, ShareClientConfig)

ShareFileClient örneği oluşturur.

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

Parametreler

url

string

Azure Depolama dosyasına işaret eden "https://myaccount.file.core.windows.net/myshare/mydirectory/file" gibi bir URL dizesi. AnonymousCredential kullanıyorsanız , "https://myaccount.file.core.windows.net/myshare/mydirectory/file?sasString" gibi bir SAS ekleyebilirsiniz. Bu yöntem, bir dosyaya işaret eden kodlanmış bir URL'yi veya kodlanmamış URL'yi kabul eder. Kodlanmış URL dizesi iki kez kaçılmaz, YALNıZCA URL yolundaki özel karakterlerden kaçılır. Ancak, bir dosya veya dizin adı %içeriyorsa, dosya veya dizin adı URL'de kodlanmalıdır. "myfile%" adlı bir dosya gibi, URL "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25" olmalıdır.

pipeline
Pipeline

Varsayılan işlem hattı oluşturmak veya özelleştirilmiş bir işlem hattı sağlamak için newPipeline() çağrısında bulunabilirsiniz.

Özellik Ayrıntıları

name

Dosyanın adı

string name

Özellik Değeri

string

path

Dosyanın tam yolu

string path

Özellik Değeri

string

shareName

Bu dosya istemcisine karşılık gelen paylaşım adı

string shareName

Özellik Değeri

string

Devralınan Özellik Detayları

accountName

accountName: string

Özellik Değeri

string

StorageClient.accountName'den Devralınan

url

URL dizesi değeri.

url: string

Özellik Değeri

string

StorageClient.url'den Devralınan

Yöntem Ayrıntıları

abortCopyFromURL(string, FileAbortCopyFromURLOptions)

Bekleyen Bir Dosya Kopyalama işlemini durdurur ve hedef dosyayı sıfır uzunlukta ve tam meta veriyle bırakır.

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

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

Parametreler

copyId

string

Durdurulacak Dosya Kopyala işleminin kimliği.

options
FileAbortCopyFromURLOptions

URL'den Kopyalamayı Durdur işlemini dosyaya aktarma seçenekleri.

Döndürülenler

clearRange(number, number, FileClearRangeOptions)

Belirtilen aralığı temizler ve bu aralık için depolamada kullanılan alanı serbest bırakır.

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

Parametreler

offset

number

contentLength

number

options
FileClearRangeOptions

Dosya Aralığı Temizleme işlemi seçenekleri.

Döndürülenler

create(number, FileCreateOptions)

Yeni bir dosya oluşturur veya bir dosyanın yerini alır. Yalnızca içeriği olmayan dosyayı başlatdığını unutmayın.

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

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

Parametreler

size

number

Dosya için bayt cinsinden en büyük boyutu (en fazla 4 TB) belirtir.

options
FileCreateOptions

Dosya Oluşturma işlemi seçenekleri.

Döndürülenler

Dosya Oluşturma işlemi için yanıt verileri.

Örnek kullanım:

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`);

Yalnızca NFS. Yol tarafından belirtilen dosya dosyasına sabit bir bağlantı oluşturur.

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

Parametreler

targetFile

string

Paylaşım dahil olmak üzere sabit bağlantı oluşturulacak dosyanın yolu. Örneğin: "targetDirectory/targetSubDirectory/.../targetFile"

options
FileCreateHardLinkOptions

Sabit bağlantı işlemi oluşturma seçenekleri.

Döndürülenler

Yalnızca NFS. Sembolik bir bağlantı oluşturur.

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

Parametreler

linkText

string

Orijinal dosyanın yolu, sembolik bağlantı işaret ediyor. Yol, çözümlenmemiş ve olduğu gibi depolanan dize türündedir. Yol, sembolik bağlantı dosyasında depolanan içeriğe bağlı olarak mutlak yol veya göreli yol olabilir.

options
FileCreateSymbolicLinkOptions

Sabit bağlantı işlemi oluşturma seçenekleri.

Döndürülenler

delete(FileDeleteOptions)

Dosyayı depolama hesabından kaldırır. Bir dosya başarıyla silindiğinde, depolama hesabının dizininden hemen kaldırılır ve artık istemciler tarafından erişilemez. Dosyanın verileri daha sonra çöp toplama sırasında hizmetten kaldırılır.

Silme Dosyası, SMB istemcisinde açıksa 409 (Çakışma) durum kodu ve SharingViolation hata koduyla başarısız olur.

Dosya Sil, paylaşımın salt okunur bir kopyası olan paylaşım anlık görüntüsünde desteklenmez. Paylaşım anlık görüntüsünde bu işlemi gerçekleştirme girişimi 400 (InvalidQueryParameterValue) ile başarısız olur

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

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

Parametreler

options
FileDeleteOptions

Dosya Silme işlemi seçenekleri.

Döndürülenler

Dosya Silme işlemi için yanıt verileri.

deleteIfExists(FileDeleteOptions)

Varsa dosyayı depolama hesabından kaldırır. Bir dosya başarıyla silindiğinde, depolama hesabının dizininden hemen kaldırılır ve artık istemciler tarafından erişilemez. Dosyanın verileri daha sonra çöp toplama sırasında hizmetten kaldırılır.

Silme Dosyası, SMB istemcisinde açıksa 409 (Çakışma) durum kodu ve SharingViolation hata koduyla başarısız olur.

Dosya Sil, paylaşımın salt okunur bir kopyası olan paylaşım anlık görüntüsünde desteklenmez. Paylaşım anlık görüntüsünde bu işlemi gerçekleştirme girişimi 400 (InvalidQueryParameterValue) ile başarısız olur

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

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

Parametreler

Döndürülenler

download(number, number, FileDownloadOptions)

Meta verileri ve özellikleri dahil olmak üzere sistemden bir dosyayı okur veya indirir.

  • Node.js'de veriler Okunabilir bir akış readableStreamBody
  • Tarayıcılarda veriler bir promise contentAsBlob

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

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

Parametreler

offset

number

Dosyanın indirilmesi gereken konumdan, 0'dan büyük veya buna eşit

count

number

ne kadar veri indirileceği, 0'dan büyük. Tanımsız olduğunda sonuna kadar indirilir

options
FileDownloadOptions

Dosya İndirme işlemi seçenekleri.

Döndürülenler

Dosya İndirme işlemi için yanıt verileri.

Örnek kullanım (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);
  });
}

Örnek kullanım (tarayıcılar):

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()}`);
}

downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Arabelleğe paralel olarak bir Azure dosyası indirir. Uzaklık ve sayı isteğe bağlıdır, her ikisi için de 0 geçirerek dosyanın tamamını indirin.

Uyarı: Arabellekler, Node.js/V8 sınırlamaları nedeniyle 32 bit sistemlerde yaklaşık bir gigabayt veya 64 bit sistemlerde yaklaşık iki gigabayt kadar dosyaları destekleyebilir. Bu boyuttan daha büyük dosyalar için downloadToFilegöz önünde bulundurun.

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

Parametreler

buffer

Buffer

Arabellek doldurulacak, uzunluğu sayıdan büyük olmalıdır

offset

number

Azure Dosyasının indirilmesi gereken konumdan

count

number

ne kadar veri indirileceği. Undefined geçirirken sonuna indirilir

Döndürülenler

Promise<Buffer>

downloadToBuffer(number, number, FileDownloadToBufferOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR

Arabelleğe paralel olarak bir Azure dosyası indirir. Uzaklık ve sayı isteğe bağlıdır, her ikisi için de 0 geçirerek dosyanın tamamını indirin

Uyarı: Arabellekler, Node.js/V8 sınırlamaları nedeniyle 32 bit sistemlerde yaklaşık bir gigabayt veya 64 bit sistemlerde yaklaşık iki gigabayt kadar dosyaları destekleyebilir. Bu boyuttan daha büyük dosyalar için downloadToFilegöz önünde bulundurun.

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

Parametreler

offset

number

Azure dosyasının indirilmesi gereken konumdan

count

number

ne kadar veri indirileceği. Undefined geçirirken sonuna indirilir

Döndürülenler

Promise<Buffer>

downloadToFile(string, number, number, FileDownloadOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Azure Blob'ları yerel bir dosyaya indirir. Verilen dosya yolu zaten çıkarsa başarısız olur. Uzaklık ve sayı isteğe bağlıdır, blob'un tamamını indirmek için sırasıyla 0 ve undefined değerini geçirir.

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

Parametreler

filePath

string

offset

number

Blok blobunun indirilmesi gereken konumdan.

count

number

ne kadar veri indirileceği. Undefined'i geçirirken sonuna kadar indirilir.

options
FileDownloadOptions

Blob indirme seçenekleri seçenekleri.

Döndürülenler

Blob indirme işlemi için yanıt verileri, ancak içeriği zaten okundu ve belirtilen yolda yerel bir dosyaya yazıldığından readableStreamBody tanımsız olarak ayarlandı.

exists(FileExistsOptions)

Belirtilen dosya varsa true döndürür; false olarak ayarlayın.

NOT: Mevcut bir dosya diğer istemciler veya uygulamalar tarafından silinebileceğinden bu işlevi dikkatli kullanın. Bu işlev tamamlandıktan sonra diğer istemciler veya uygulamalar tarafından yeni dosyalar eklenebilir.

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

Parametreler

options
FileExistsOptions

seçeneklerine tıklayın.

Döndürülenler

Promise<boolean>

forceCloseAllHandles(FileForceCloseHandlesOptions)

Bir dosyanın tüm tanıtıcılarını zorla kapatın.

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

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

Parametreler

options
FileForceCloseHandlesOptions

Tanıtıcıları kapatma işlemini zorlama seçenekleri.

Döndürülenler

Promise<CloseHandlesInfo>

forceCloseHandle(string, FileForceCloseHandlesOptions)

Bir dosya için belirli bir tanıtıcıyı kapatmaya zorlar.

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

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

Parametreler

handleId

string

Belirli tanıtıcı kimliği, yıldız işareti "*" olamaz. Tüm tanıtıcıları kapatmak için forceCloseAllHandles() kullanın.

Döndürülenler

generateSasStringToSign(FileGenerateSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle inşa edilen istemciler için kullanılabilir.

Geçirilen istemci özelliklerine ve parametrelerine göre Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini imzalamak için dize oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır.

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

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

Parametreler

options
FileGenerateSasUrlOptions

İsteğe bağlı parametreler.

Döndürülenler

string

Bu istemci tarafından temsil edilen kaynağın URI'sini ve ardından oluşturulan SAS belirtecini içeren SAS URI'sini.

generateSasUrl(FileGenerateSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle inşa edilen istemciler için kullanılabilir.

geçirilen istemci özelliklerine ve parametrelerine göre bir Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır.

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

function generateSasUrl(options: FileGenerateSasUrlOptions): string

Parametreler

options
FileGenerateSasUrlOptions

İsteğe bağlı parametreler.

Döndürülenler

string

Bu istemci tarafından temsil edilen kaynağın URI'sini ve ardından oluşturulan SAS belirtecini içeren SAS URI'sini.

generateUserDelegationSasUrl(ShareGenerateSasUrlOptions, UserDelegationKey)

geçirilen istemci özelliklerine ve parametrelerine göre bir Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, kullanıcı delegasyonu anahtarı kimlik bilgisi girişiyle imzalanır.

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

function generateUserDelegationSasUrl(options: ShareGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parametreler

options
ShareGenerateSasUrlOptions

İsteğe bağlı parametreler.

userDelegationKey
UserDelegationKey

SAS URI'sini imzalamak için kullanılan kullanıcı delegasyonu anahtarı

Döndürülenler

string

Bu istemci tarafından temsil edilen kaynağın URI'sini ve ardından oluşturulan SAS belirtecini içeren SAS URI'sini.

generateUserDelegationStringToSign(ShareGenerateSasUrlOptions, UserDelegationKey)

geçirilen istemci özelliklerine ve parametrelerine göre bir Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, kullanıcı delegasyonu anahtarı kimlik bilgisi girişiyle imzalanır.

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

function generateUserDelegationStringToSign(options: ShareGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parametreler

options
ShareGenerateSasUrlOptions

İsteğe bağlı parametreler.

userDelegationKey
UserDelegationKey

SAS URI'sini imzalamak için kullanılan kullanıcı delegasyonu anahtarı

Döndürülenler

string

Bu istemci tarafından temsil edilen kaynağın URI'sini ve ardından oluşturulan SAS belirtecini içeren SAS URI'sini.

getProperties(FileGetPropertiesOptions)

Dosya için tüm kullanıcı tanımlı meta verileri, standart HTTP özelliklerini ve sistem özelliklerini döndürür. Dosyanın içeriğini döndürmez.

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

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

Parametreler

options
FileGetPropertiesOptions

Dosya Alma Özellikleri işlemi seçenekleri.

Döndürülenler

Dosya Alma Özellikleri işleminin yanıt verileri.

getRangeList(FileGetRangeListOptions)

Bir dosya için geçerli aralıkların listesini döndürür.

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

Parametreler

options
FileGetRangeListOptions

Dosya Alma aralığı Listesi işlemi seçenekleri.

Döndürülenler

getRangeListDiff(string, FileGetRangeListOptions)

Önceki paylaşım anlık görüntüsüyle bu dosya arasında farklılık gösteren aralıkların listesini döndürür.

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

Parametreler

prevShareSnapshot

string

Önceki anlık görüntü parametresi, karşılaştırmak için önceki paylaşım anlık görüntüsünü belirten opak bir DateTime değeridir.

Döndürülenler

getShareLeaseClient(string)

Dosyadaki kiraları yöneten bir ShareLeaseClient alın.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Parametreler

proposeLeaseId

string

İlk önerilen kira kimliği.

Döndürülenler

Dosyadaki kiraları yönetmek için yeni bir ShareLeaseClient nesnesi.

Yalnızca NFS. Sembolik bir bağlantının içeriğini alır.

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

Parametreler

options
FileGetSymbolicLinkOptions

Sembolik bağlantı işlemi almak için seçenekler.

Döndürülenler

listHandles(FileListHandlesOptions)

Tüm tanıtıcıları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür. öğesini seçin.

.byPage() sayfalardaki tanıtıcıları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

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

Parametreler

options
FileListHandlesOptions

Liste işlemeleri işlemi seçenekleri.

Disk belleğini destekleyen asyncIterableIterator.

Döndürülenler

rename(string, FileRenameOptions)

Dosyayı yeniden adlandırır. Bu API yalnızca aynı paylaşımdaki bir dosyanın yeniden adlandırılabilmesini destekler.

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

Parametreler

destinationPath

string

Yeniden adlandıracak hedef yolu belirtir. Yol, hedefi belirtmek için url'ye yerleştirilecek şekilde kodlanır.

options
FileRenameOptions

Yeniden adlandırma işlemi seçenekleri.

Döndürülenler

Promise<{ destinationFileClient: ShareFileClient, fileRenameResponse: FileRenameResponse }>

Dosya yeniden adlandırma işlemi için yanıt verileri.

Örnek kullanım:

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);

resize(number, FileResizeOptions)

Dosyayı yeniden boyutlandırın.

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

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

Parametreler

length

number

Bir dosyayı bayt cinsinden belirtilen boyuta yeniden boyutlandırıyor. Belirtilen bayt değeri dosyanın geçerli boyutundan küçükse, belirtilen bayt değerinin üzerindeki tüm aralıklar temizlenir.

options
FileResizeOptions

Dosya Yeniden Boyutlandırma işlemi seçenekleri.

Döndürülenler

Dosya Kümesi HTTP Üst Bilgileri işlemi için yanıt verileri.

setHttpHeaders(FileHttpHeaders, FileSetHttpHeadersOptions)

Dosyada HTTP üst bilgilerini ayarlar.

Seçenek sağlanmadıysa veya seçeneklerdeki dosya HTTP üst bilgileri için değer sağlanmadıysa, bu dosya HTTP üst bilgileri bir değer olmadan temizlenir.

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

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

Parametreler

fileHttpHeaders
FileHttpHeaders
options
FileSetHttpHeadersOptions

Dosya Kümesi HTTP Üst Bilgileri işlemi seçenekleri.

Döndürülenler

Dosya Kümesi HTTP Üst Bilgileri işlemi için yanıt verileri.

setMetadata(Metadata, FileSetMetadataOptions)

Belirtilen dosya için kullanıcı tanımlı meta verileri güncelleştirir.

seçenek parametresinde tanımlı meta veri yoksa, dosya meta verileri kaldırılır.

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

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

Parametreler

metadata
Metadata

Meta veri sağlanmazsa, var olan tüm dizin meta verileri kaldırılır

options
FileSetMetadataOptions

Dosya Kümesi Meta Verileri işlemi seçenekleri.

Döndürülenler

Dosya Kümesi Meta Verileri işlemi için yanıt verileri.

setProperties(FileProperties)

Dosyadaki özellikleri ayarlar.

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

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

Parametreler

properties
FileProperties

Dosya özellikleri. Dosya HTTP üst bilgileri (örneğin, content-Type) için değer sağlanmazsa, mevcut HTTP üst bilgileri kaldırılır. Diğer dosya özellikleri (ör. fileAttributes) için değer sağlanmazsa, mevcut değerler korunur.

Döndürülenler

startCopyFromURL(string, FileStartCopyOptions)

Bir blobu veya dosyayı depolama hesabındaki hedef dosyaya kopyalar.

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

Parametreler

copySource

string

Kaynak dosyanın veya blobun URL'sini en fazla 2 KB uzunluğunda belirtir. Bir dosyayı aynı depolama hesabındaki başka bir dosyaya kopyalamak için Paylaşılan Anahtar'ı kullanarak kaynak dosyanın kimliğini doğrulayabilirsiniz. Başka bir depolama hesabından dosya kopyalanıyorsa veya aynı depolama hesabından veya başka bir depolama hesabından bir blob kopyalanıyorsa, paylaşılan erişim imzası kullanarak kaynak dosyanın veya blob'un kimliğini doğrulamanız gerekir. Kaynak bir genel blobsa, kopyalama işlemini gerçekleştirmek için kimlik doğrulaması gerekmez. Paylaşım anlık görüntüsündeki bir dosya da kopyalama kaynağı olarak belirtilebilir.

options
FileStartCopyOptions

Dosya Kopyalamayı Başlat işlemi seçenekleri.

Döndürülenler

uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, FileParallelUploadOptions)

Yeni bir Azure Dosyası oluşturur veya var olan bir Azure Dosyasının yerini alır ve ardından bir Buffer(Node)/Blob/ArrayBuffer/ArrayBufferView yükler.

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

Parametreler

data

Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node), Blob, ArrayBuffer veya ArrayBufferView

Döndürülenler

Promise<void>

uploadFile(string, FileParallelUploadOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Yeni bir Azure Dosyası oluşturur veya mevcut bir Azure Dosyasının yerini alır ve ardından yerel bir dosyayı bu dosyaya yükler.

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

Parametreler

filePath

string

Yerel dosyanın tam yolu

Döndürülenler

Promise<void>

uploadRange(RequestBodyType, number, number, FileUploadRangeOptions)

Dosyaya bir bayt aralığı yükleyin. Bu işlem yalnızca mevcut bir dosyada çağrılabilir. Dosyanın boyutunu, özelliklerini veya meta verilerini değiştirmez. Aralığın hem başlangıcı hem de sayısı belirtilmelidir. Aralığın boyutu 4 MB'a kadar olabilir.

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

Parametreler

body
HttpRequestBody

Blob, dize, ArrayBuffer, ArrayBufferView veya uzaklığı veri kaynağından başlayan yeni bir Okunabilir akış döndüren bir işlev.

offset

number

Karşıya yüklenecek hedef Azure Dosyasının uzaklık konumu.

contentLength

number

Bayt cinsinden gövde uzunluğu. Base64/Onaltılık kodlanmamış karakterler de dahil olmak üzere bir dizenin gövde uzunluğunu hesaplamak için Buffer.byteLength() kullanın.

options
FileUploadRangeOptions

Dosya Karşıya Yükleme Aralığı işlemi seçenekleri.

Döndürülenler

Dosya Karşıya Yükleme Aralığı işlemi için yanıt verileri.

Örnek kullanım:

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`);

uploadRangeFromURL(string, number, number, number, FileUploadRangeFromURLOptions)

İçeriğin başka bir dosyanın URL'sinden okunduğu bir dosyaya bir bayt aralığı yükleyin. Aralığın boyutu 4 MB'a kadar olabilir.

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

Parametreler

sourceURL

string

Kopyalama kaynağının URL'sini belirtin; kimlik doğrulaması için paylaşılan erişim imzası (SAS) gerekebilir.

sourceOffset

number

Kopyalanacak kaynak uzaklığı. Kaynak dosyanın başından kopyalanacak 0 değerini geçirin.

destOffset

number

Hedef dosyanın uzaklığı.

count

number

Kaynak dosyadan karşıya yüklenecek bayt sayısı.

options
FileUploadRangeFromURLOptions

Dosya - URL'den Karşıya Yükleme Aralığı işlemini yapılandırma seçenekleri.

Döndürülenler

uploadResetableStream((offset: number, count?: number) => ReadableStream, number, FileParallelUploadOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Node.js Okunabilir akış fabrikasını kabul eder ve bloklar halinde bir Azure Dosyasına yükler. Okunabilir akış fabrikası, tanımlanan uzaklıktan başlayarak Node.js Okunabilir bir akış döndürmelidir. Uzaklık, karşıya yüklenecek Azure dosyasındaki uzaklıktır.

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

Parametreler

streamFactory

(offset: number, count?: number) => ReadableStream

Tanımlanan uzaklıktan başlayarak Node.js Okunabilir bir akış döndürür

size

number

Azure dosyasının boyutu

Döndürülenler

Promise<void>

uploadSeekableBlob((offset: number, size: number) => Blob, number, FileParallelUploadOptions)

YALNıZCA TARAYıCıLARDA KULLANıLABILIR.

Tarayıcı Blob nesnesini bir Azure dosyasına yükler. Veri kaynağı olarak bir blobFactory gerektirir ve bu da sağlanan uzaklık ve boyuta sahip bir Blob nesnesi döndürmesi gerekir.

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

Parametreler

blobFactory

(offset: number, size: number) => Blob

size

number

Döndürülenler

Promise<void>

uploadStream(Readable, number, number, number, FileUploadStreamOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Yeni bir Azure Dosyası oluşturur veya mevcut bir Azure Dosyasının yerini alır ve ardından Node.js Okunabilir bir akışı bu dosyaya yükler. Bu yöntem bir Azure Dosyası oluşturmaya çalışır ve öbekleri öbek olarak karşıya yüklemeye başlar. Öbek boyutu bufferSize parametresiyle tanımlanır. Lütfen olası akış boyutunun dosya boyutunu aşmadığından emin olun.

PERFORMANS GELIŞTIRME IPUÇLARı:

  • Giriş akışı highWaterMark, Buffer.concat() işlemlerinden kaçınacak bufferSize parametresiyle aynı değeri ayarlamak daha iyidir.
function uploadStream(stream: Readable, size: number, bufferSize: number, maxBuffers: number, options?: FileUploadStreamOptions): Promise<void>

Parametreler

stream

Readable

Okunabilir akışı Node.js. Dosya boyutundan küçük veya eşit olmalıdır.

size

number

Oluşturulacak dosyanın boyutu. İzin verilen boyut üst sınırı 4 TB'tır. Bu değer akış boyutundan büyükse, dosya kuyruğunda boş baytlar olacaktır.

bufferSize

number

Bayt cinsinden ayrılan her arabelleğin boyutu, ayrıca karşıya yüklenen dosya sırasındaki öbek/aralık boyutu. Boyut 0'dan büyük ve 4 * 1024 * 1024 (4 MB) değerinden küçük veya daha küçük olmalıdır

maxBuffers

number

Maksimum arabellekler karşıya yükleme sırasında ayrılacak, maksimum karşıya yükleme eşzamanlılığı ile pozitif bağıntı

Döndürülenler

Promise<void>

withShareSnapshot(string)

Kaynakla aynı ancak belirtilen paylaşım anlık görüntüsü zaman damgasıyla yeni bir ShareFileClient nesnesi oluşturur. "" değerini sağlayın, anlık görüntüyü kaldırır ve temel ShareFileClient url'sine bir URL döndürür.

function withShareSnapshot(shareSnapshot: string): ShareFileClient

Parametreler

shareSnapshot

string

Anlık görüntü paylaşma zaman damgası.

Döndürülenler

Kaynakla aynı ancak belirtilen paylaşım anlık görüntüsü zaman damgasına sahip yeni bir ShareFileClient nesnesi.