BlockBlobClient class

Başvuru

Paket:: @azure/storage-blob

BlockBlobClient, blok blobları için geçerli olan bir işlem kümesini tanımlar.

Extends: BlobClient

Oluşturucular

BlockBlobClient(string, PipelineLike)	BlockBlobClient örneği oluşturur. Bu yöntem, blok blobuna 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. Blob adından biri varsa? veya %blob adı URL'de kodlanmalıdır.
BlockBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	BlockBlobClient örneği oluşturur. Bu yöntem, blok blobuna 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. Blob adından biri varsa? veya %blob adı URL'de kodlanmalıdır.
BlockBlobClient(string, string, string, StoragePipelineOptions)	BlockBlobClient örneği oluşturur.

Özellikler

containerName	Blobun ilişkili olduğu depolama kapsayıcısının adı.
name	Blobun adı.

Devralınan Özellikler

accountName
credential	AnonymousCredential, StorageSharedKeyCredential gibi veya hizmete yönelik isteklerin kimliğini doğrulamak için `@azure/identity` paketindeki herhangi bir kimlik bilgisi. TokenCredential arabirimini uygulayan bir nesne de sağlayabilirsiniz. Belirtilmezse, AnonymousCredential kullanılır.
url	Kodlanmış URL dizesi değeri.

Yöntemler

commitBlockList(string[], BlockBlobCommitBlockListOptions)	Blobu oluşturan blok kimliklerinin listesini belirterek bir blob yazar. Bir blobun parçası olarak yazılabilmesi için, bir bloğun sunucuya önceki aşamaBlock işleminde başarıyla yazılmış olması gerekir. Yalnızca değiştirilen blokları karşıya yükleyip yeni ve mevcut blokları birlikte işleyerek blobu güncelleştirmek için commitBlockList çağırabilirsiniz. Blok listesinde belirtilmeyen ve kalıcı olarak silinen tüm bloklar. Bkz. https://docs.microsoft.com/rest/api/storageservices/put-block-list
getBlockList(BlockListType, BlockBlobGetBlockListOptions)	Belirtilen blok listesi filtresi kullanılarak bir blok blobunun parçası olarak karşıya yüklenen blokların listesini döndürür. Bkz. https://docs.microsoft.com/rest/api/storageservices/get-block-list
query(string, BlockBlobQueryOptions)	YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR. JSON veya CSV biçimli blob için hızlı sorgu. Örnek kullanım (Node.js): // Query and convert a blob to a string const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage"); const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString(); console.log("Query blob content:", downloaded); async function streamToBuffer(readableStream) { return new Promise((resolve, reject) => { const chunks = []; readableStream.on("data", (data) => { chunks.push(data instanceof Buffer ? data : Buffer.from(data)); }); readableStream.on("end", () => { resolve(Buffer.concat(chunks)); }); readableStream.on("error", reject); }); }
stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)	Belirtilen bloğu, daha sonra commitBlockList çağrısıyla işlenecek blok blobunun "hazırlama alanına" yükler. Bkz. https://docs.microsoft.com/rest/api/storageservices/put-block
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)	URL'den Blok Hazırlama işlemi, içeriğin URL'den okunduğu bir blobun parçası olarak işlenecek yeni bir blok oluşturur. Bu API, 2018-03-28 sürümünden itibaren kullanılabilir. Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url
syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)	Blobun içeriğinin belirli bir URL'den okunduğu yeni bir Blok Blobu oluşturur. Bu API, 2020-04-08 sürümünden itibaren desteklenir. URL'den Blob Koy ile kısmi güncelleştirmeler desteklenmez; Var olan bir blobun içeriğinin üzerine yeni blobun içeriği yazılır. Kaynak URL kullanarak blok blobu içeriğinde kısmi güncelleştirmeler gerçekleştirmek için stageBlockFromURL kullanın ve commitBlockList.
upload(RequestBodyType, number, BlockBlobUploadOptions)	Yeni bir blok blobu oluşturur veya mevcut blok blobunun içeriğini güncelleştirir. Mevcut bir blok blobunun güncelleştirilmesi, blob üzerindeki mevcut meta verilerin üzerine yazılır. Kısmi güncelleştirmeler desteklenmez; Mevcut blobun içeriğinin üzerine yeni içerik yazılır. Blok bloblarının kısmi güncelleştirmesini gerçekleştirmek için stageBlock kullanın ve commitBlockList. Bu paralel olmayan bir karşıya yükleme yöntemidir, eşzamanlılık yüklemesinde daha iyi performans için lütfen uploadFilekullanın uploadStream veya uploadBrowserData. Bkz. https://docs.microsoft.com/rest/api/storageservices/put-blob
uploadBrowserData(Blob \| ArrayBuffer \| ArrayBufferView, BlockBlobParallelUploadOptions)	YALNıZCA TARAYıCıLARDA KULLANıLABILIR. Blok blobu için bir tarayıcı Blobu/Dosyası/ArrayBuffer/ArrayBufferView nesnesini karşıya yükler. Arabellek uzunluğu 256 MB'tan küçük veya buna eşit olduğunda, bu yöntem karşıya yüklemeyi tamamlamak için 1 karşıya yükleme çağrısı kullanır. Aksi takdirde, bu yöntem blokları karşıya yüklemek için stageBlock çağırır ve son olarak blok listesini işlemek için commitBlockList çağırır. Ayarlamaya yönelik yaygın blobHTTPHeaders seçeneği `blobContentType`, tarayıcının dosya türüne göre işlevsellik sağlamasına olanak tanır.
uploadData(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, BlockBlobParallelUploadOptions)	Buffer(Node.js)/Blob(tarayıcılar)/ArrayBuffer/ArrayBufferView nesnesini BlockBlob'a yükler. Veri uzunluğu belirtilen maxSingleShotSize (varsayılan değer <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>) değerinden farklı olmadığında, bu yöntem karşıya yüklemeyi tamamlamak için 1 karşıya yükleme çağrısı kullanır. Aksi takdirde, bu yöntem blokları karşıya yüklemek için stageBlock çağırır ve son olarak blok listesini işlemek için commitBlockList çağırır. Ayarlamaya yönelik yaygın blobHTTPHeaders seçeneği `blobContentType`, tarayıcının dosya türüne göre işlevsellik sağlamasına olanak tanır.
uploadFile(string, BlockBlobParallelUploadOptions)	YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR. Bloklar halinde yerel bir dosyayı blok bloba yükler. Dosya boyutu 256 MB'tan küçük veya buna eşit olduğunda, bu yöntem karşıya yüklemeyi tamamlamak için 1 karşıya yükleme çağrısı kullanır. Aksi takdirde, bu yöntem blokları karşıya yüklemek için stageBlock'u çağırır ve son olarak blok listesini işlemek için commitBlockList öğesini çağırır.
uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)	YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR. Node.js Okunabilir bir akışı blok blobuna yükler. PERFORMANS GELIŞTIRME IPUÇLARı: Giriş akışı highWaterMark, Buffer.concat() işlemlerinden kaçınacak bufferSize parametresiyle aynı değeri ayarlamak daha iyidir.
withSnapshot(string)	Kaynakla aynı ancak belirtilen anlık görüntü zaman damgasıyla yeni bir BlockBlobClient nesnesi oluşturur. "" değerini sağlayın, anlık görüntüyü kaldırır ve temel bloba bir URL döndürür.

Devralınan Yöntemler

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Bekleyen bir zaman uyumsuz Kopyalama Blobu işlemini durdurur ve sıfır uzunlukta ve tam meta veri içeren bir hedef blob bırakır. Sürüm 2012-02-12 ve daha yeni. Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	Blobu zaman uyumsuz olarak depolama hesabı içindeki bir hedefe kopyalar. Bu yöntem, kopya tamamlanana kadar süresiz olarak beklemenize olanak tanıyan uzun süre çalışan bir işlem poller döndürür. Ayrıca, bir kopya tamamlanmadan önce poller üzerindeki `cancelOperation` çağırarak da iptal edebilirsiniz. İlk istekte işlem tamamlanırsa onProgress geri çağırmasının çağrılmadığını ve tamamlanmış bir kopyanın iptal edilmeye çalışılmasının hataya neden olacağını unutmayın. Sürüm 2012-02-12 ve sonraki sürümlerde, Blobu Kopyalama işleminin kaynağı herhangi bir Azure depolama hesabında kaydedilmiş bir blob olabilir. 2015-02-21 sürümünden başlayarak, Blobu Kopyalama işleminin kaynağı herhangi bir Azure depolama hesabındaki bir Azure dosyası olabilir. Yalnızca 7 Haziran 2012 veya sonrasında oluşturulan depolama hesapları, Blobu Kopyala işleminin başka bir depolama hesabından kopyalamasına izin verir. Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob Otomatik yoklama kullanma örneği: `const copyPoller = await blobClient.beginCopyFromURL('url'); const result = await copyPoller.pollUntilDone();` El ile yoklama kullanma örneği: `const copyPoller = await blobClient.beginCopyFromURL('url'); while (!poller.isDone()) { await poller.poll(); } const result = copyPoller.getResult();` İlerleme güncelleştirmelerini kullanan örnek: const copyPoller = await blobClient.beginCopyFromURL('url', { onProgress(state) { console.log(`Progress: ${state.copyProgress}`); } }); const result = await copyPoller.pollUntilDone(); Değişen yoklama aralığının (varsayılan 15 saniye) kullanıldığı örnek: `const copyPoller = await blobClient.beginCopyFromURL('url', { intervalInMs: 1000 // poll blob every 1 second for copy progress }); const result = await copyPoller.pollUntilDone();` Kopyalama iptali kullanma örneği: `const copyPoller = await blobClient.beginCopyFromURL('url'); // cancel operation after starting it. try { await copyPoller.cancelOperation(); // calls to get the result now throw PollerCancelledError await copyPoller.getResult(); } catch (err) { if (err.name === 'PollerCancelledError') { console.log('The copy was cancelled.'); } }`
createSnapshot(BlobCreateSnapshotOptions)	Blobun salt okunur anlık görüntüsünü oluşturur. Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
delete(BlobDeleteOptions)	Belirtilen blobu veya anlık görüntüyü silinmek üzere işaretler. Blob daha sonra çöp toplama sırasında silinir. Bir blobu silmek için tüm anlık görüntülerini silmeniz gerektiğini unutmayın. Blobu Sil işlemiyle ikisini de aynı anda silebilirsiniz. Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteIfExists(BlobDeleteOptions)	Varsa, belirtilen blobu veya anlık görüntüyü silinmek üzere işaretler. Blob daha sonra çöp toplama sırasında silinir. Bir blobu silmek için tüm anlık görüntülerini silmeniz gerektiğini unutmayın. Blobu Sil işlemiyle ikisini de aynı anda silebilirsiniz. Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Blobdaki değişmezlik ilkesini silin.
download(number, number, BlobDownloadOptions)	Meta verileri ve özellikleri dahil olmak üzere bir blobu sistemden okur veya indirir. Anlık görüntüyü okumak için Blob Al'ı da çağırabilirsiniz. Node.js'de veriler okunabilir bir akışta döndürülebilirStreamBody içinde döndürülüyor Tarayıcılarda veriler promise blobBody içinde döndürülüyor Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR. Arabelleğe paralel olarak bir Azure Blobu indirir. Uzaklık ve sayı isteğe bağlıdır, sağlanmazsa blob'un tamamını indirir. 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 büyük bloblar için downloadToFilegöz önünde bulundurun.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR. Arabelleğe paralel olarak bir Azure Blobu indirir. Uzaklık ve sayı isteğe bağlıdır, sağlanmazsa blob'un tamamını indirir. 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 büyük bloblar için downloadToFilegöz önünde bulundurun.
downloadToFile(string, number, number, BlobDownloadOptions)	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(BlobExistsOptions)	Bu istemci tarafından temsil edilen Azure blob kaynağı varsa true döndürür; false olarak ayarlayın. NOT: Mevcut bir blob 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 bloblar eklenebilir.
generateSasUrl(BlobGenerateSasUrlOptions)	Yalnızca paylaşılan anahtar kimlik bilgileriyle yapılan BlobClient için kullanılabilir. geçirilen istemci özelliklerine ve parametrelerine göre bir Blob Hizmeti Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır. Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccountInfo(BlobGetAccountInfoOptions)	Hesap Bilgilerini Al işlemi, belirtilen hesap için sku adını ve hesap türünü döndürür. Hesap Bilgilerini Al işlemi, sürüm 2018-03-28 ile başlayan hizmet sürümlerinde kullanılabilir. Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
getAppendBlobClient()	AppendBlobClient nesnesi oluşturur.
getBlobLeaseClient(string)	Blob üzerindeki kiraları yöneten bir BlobLeaseClient alın.
getBlockBlobClient()	BlockBlobClient nesnesi oluşturur.
getPageBlobClient()	PageBlobClient nesnesi oluşturur.
getProperties(BlobGetPropertiesOptions)	Blob için tüm kullanıcı tanımlı meta verileri, standart HTTP özelliklerini ve sistem özelliklerini döndürür. Blobun içeriğini döndürmez. Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties UYARI: Yanıtta döndürülen `metadata` nesnesinin anahtarları başlangıçta büyük harf karakterler içerse bile küçük harfle gösterilir. Bu, özgün büyük/küçük harflerini koruyacak `includeMetadata` seçeneğini kullanarak blobları listeleyen ContainerClient yöntemleri tarafından döndürülen meta veri anahtarlarından farklıdır.
getTags(BlobGetTagsOptions)	Temel alınan blobla ilişkili etiketleri alır.
setAccessTier(string, BlobSetTierOptions)	Blob üzerindeki katmanı ayarlar. İşleme premium depolama hesabındaki bir sayfa blobunda ve blob depolama hesabındaki bir blok blobunda izin verilir (yalnızca yerel olarak yedekli depolama). Premium sayfa blobunun katmanı blobun izin verilen boyutunu, IOPS'sini ve bant genişliğini belirler. Blok blobu katmanı Sık Erişimli/Seyrek Erişimli/Arşiv depolama türünü belirler. Bu işlem blob'un ETag'ini güncelleştirmez. Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	Blob üzerindeki sistem özelliklerini ayarlar. Belirtilen blob HTTP üst bilgileri için değer sağlanmazsa veya değer sağlanmazsa, değeri olmayan bu blob HTTP üst bilgileri temizlenir. Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Blob üzerinde değişmezlik ilkesini ayarlayın.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Blob üzerinde yasal saklama ayarlayın.
setMetadata(Metadata, BlobSetMetadataOptions)	Belirtilen blob için kullanıcı tanımlı meta verileri bir veya daha fazla ad-değer çifti olarak ayarlar. Seçenek sağlanmadıysa veya parametrede tanımlı meta veri yoksa blob meta verileri kaldırılır. Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setTags(Tags, BlobSetTagsOptions)	Temel alınan blob üzerindeki etiketleri ayarlar. Bir blobda en fazla 10 etiket olabilir. Etiket anahtarları 1 ile 128 karakter arasında olmalıdır. Etiket değerleri 0 ile 256 karakter arasında olmalıdır. Geçerli etiket anahtarı ve değer karakterleri küçük ve büyük harf, basamak (0-9), boşluk (' '), artı ('+'), eksi ('-'), nokta ('.'), eğik çizgi ('/'), iki nokta üst üste (':'), eşittir ('=') ve alt çizgi ('_') içerir.
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	Zaman uyumlu URL'den Kopyala işlemi bir blobu veya İnternet kaynağını yeni bir bloba kopyalar. Kopya tamamlanana kadar yanıt döndürmez. Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
undelete(BlobUndeleteOptions)	Geçici olarak silinen blobun içeriğini ve meta verilerini ve ilişkili geçici silinen anlık görüntüleri geri yükler. Blobu Geri Alma yalnızca 2017-07-29 veya sonraki bir sürümde desteklenir. Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
withVersion(string)	Bu blobun bir sürümünü işaret eden yeni bir BlobClient nesnesi oluşturur. "" değerini sağlayın, versionId değerini kaldırır ve temel bloba bir İstemci döndürür.

Oluşturucu Ayrıntıları

BlockBlobClient(string, PipelineLike)

BlockBlobClient örneği oluşturur. Bu yöntem, blok blobuna 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. Blob adından biri varsa? veya %blob adı URL'de kodlanmalıdır.

new BlockBlobClient(url: string, pipeline: PipelineLike)

Parametreler

url: string

Azure Depolama blok blobu'na işaret eden "https://myaccount.blob.core.windows.net/mycontainer/blockblob" gibi bir URL dizesi. AnonymousCredential kullanıyorsanız , "https://myaccount.blob.core.windows.net/mycontainer/blockblob?sasString" gibi bir SAS ekleyebilirsiniz. Bu yöntem bir bloba 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 blob adı içeriyorsa? veya %blob adı URL'de kodlanmalıdır. "my?blob%" adlı bir blob gibi, URL "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25" olmalıdır.

pipeline: PipelineLike

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

BlockBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

new BlockBlobClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parametreler

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

AnonymousCredential, StorageSharedKeyCredential gibi veya hizmete yönelik isteklerin kimliğini doğrulamak için @azure/identity paketindeki herhangi bir kimlik bilgisi. TokenCredential arabirimini uygulayan bir nesne de sağlayabilirsiniz. Belirtilmezse, AnonymousCredential kullanılır.

options: StoragePipelineOptions

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

BlockBlobClient(string, string, string, StoragePipelineOptions)

BlockBlobClient örneği oluşturur.

new BlockBlobClient(connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)

Parametreler

connectionString: string

Bir Azure depolama hesabının hesap bağlantı dizesi veya SAS bağlantı dizesi. [ Not - Hesap bağlantı dizesi yalnızca NODE.JS çalışma zamanında kullanılabilir. ] Hesap bağlantı dizesi örneği - SAS bağlantı dizesi örneği DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

containerName: string

Kapsayıcı adı.

blobName: string

Blob adı.

options: StoragePipelineOptions

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

Özellik Ayrıntıları

containerName

Blobun ilişkili olduğu depolama kapsayıcısının adı.

string containerName

Özellik Değeri

string

name

Blobun adı.

string name

Özellik Değeri

string

Devralınan Özellik Detayları

accountName

accountName: string

Özellik Değeri

string

BlobClient.accountNameDevralındı

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Özellik Değeri

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

BlobClient.credential Devralınmış

url

Kodlanmış URL dizesi değeri.

url: string

Özellik Değeri

string

BlobClient.urlDevralındı

Yöntem Ayrıntıları

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Blobu oluşturan blok kimliklerinin listesini belirterek bir blob yazar. Bir blobun parçası olarak yazılabilmesi için, bir bloğun sunucuya önceki aşamaBlock işleminde başarıyla yazılmış olması gerekir. Yalnızca değiştirilen blokları karşıya yükleyip yeni ve mevcut blokları birlikte işleyerek blobu güncelleştirmek için commitBlockList çağırabilirsiniz. Blok listesinde belirtilmeyen ve kalıcı olarak silinen tüm bloklar.

Bkz. https://docs.microsoft.com/rest/api/storageservices/put-block-list

function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions): Promise<BlockBlobCommitBlockListResponse>

Parametreler

blocks: string[]

Base64 ile kodlanmış 64 baytlık değer dizisi

options: BlockBlobCommitBlockListOptions

Blok Blobu İşleme Blok Listesi işlemine yönelik seçenekler.

Döndürülenler

Promise<BlockBlobCommitBlockListResponse>

Blok Blobu İşleme Blok Listesi işlemi için yanıt verileri.

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

Belirtilen blok listesi filtresi kullanılarak bir blok blobunun parçası olarak karşıya yüklenen blokların listesini döndürür.

Bkz. https://docs.microsoft.com/rest/api/storageservices/get-block-list

function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions): Promise<BlockBlobGetBlockListResponse>

Parametreler

listType: BlockListType

İşlendi blok listesinin mi, kaydedilmemiş blokların listesinin mi yoksa her iki listenin birlikte mi döndürülmeyeceğini belirtir.

options: BlockBlobGetBlockListOptions

Blok Blobu Alma Blok Listesi işlemine yönelik seçenekler.

Döndürülenler

Promise<BlockBlobGetBlockListResponse>

Blok Blobu Alma Blok Listesi işlemi için yanıt verileri.

query(string, BlockBlobQueryOptions)

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

JSON veya CSV biçimli blob için hızlı sorgu.

Örnek kullanım (Node.js):

// Query and convert a blob to a string
const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString();
console.log("Query blob content:", downloaded);

async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

function query(query: string, options?: BlockBlobQueryOptions): Promise<BlobDownloadResponseModel>

Parametreler

query: string

options: BlockBlobQueryOptions

Döndürülenler

Promise<BlobDownloadResponseModel>

stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

Belirtilen bloğu, daha sonra commitBlockList çağrısıyla işlenecek blok blobunun "hazırlama alanına" yükler.

Bkz. https://docs.microsoft.com/rest/api/storageservices/put-block

function stageBlock(blockId: string, body: RequestBodyType, contentLength: number, options?: BlockBlobStageBlockOptions): Promise<BlockBlobStageBlockResponse>

Parametreler

blockId: string

Base64 ile kodlanmış 64 baytlık bir değer

body: HttpRequestBody

Hazırlama alanına yüklenecek veriler.

contentLength: number

Karşıya yüklenecek bayt sayısı.

options: BlockBlobStageBlockOptions

Blok Blobu Aşama Bloğu işlemine yönelik seçenekler.

Döndürülenler

Promise<BlockBlobStageBlockResponse>

Blok Blobu Aşama Bloğu işlemi için yanıt verileri.

stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)

URL'den Blok Hazırlama işlemi, içeriğin URL'den okunduğu bir blobun parçası olarak işlenecek yeni bir blok oluşturur. Bu API, 2018-03-28 sürümünden itibaren kullanılabilir.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url

function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions): Promise<BlockBlobStageBlockFromURLResponse>

Parametreler

blockId: string

Base64 ile kodlanmış 64 baytlık bir değer

sourceURL: string

Blobun URL'sini belirtir. Değer, blob belirten en fazla 2 KB uzunluğunda bir URL olabilir. Değer, istek URI'sinde göründüğü gibi URL ile kodlanmış olmalıdır. Kaynak blob genel olmalıdır veya paylaşılan erişim imzası aracılığıyla kimlik doğrulaması yapılmalıdır. Kaynak blob genel ise, işlemi gerçekleştirmek için kimlik doğrulaması gerekmez. Kaynak nesne URL'lerine bazı örnekler aşağıda verilmiştir: - https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

offset: number

Blobun 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: BlockBlobStageBlockFromURLOptions

URL'den Blob Aşama Bloğunu Engelle işlemine yönelik seçenekler.

Döndürülenler

Promise<BlockBlobStageBlockFromURLResponse>

URL'den Blok Blobu Aşama Bloğu işlemi için yanıt verileri.

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Blobun içeriğinin belirli bir URL'den okunduğu yeni bir Blok Blobu oluşturur. Bu API, 2020-04-08 sürümünden itibaren desteklenir. URL'den Blob Koy ile kısmi güncelleştirmeler desteklenmez; Var olan bir blobun içeriğinin üzerine yeni blobun içeriği yazılır. Kaynak URL kullanarak blok blobu içeriğinde kısmi güncelleştirmeler gerçekleştirmek için stageBlockFromURL kullanın ve commitBlockList.

function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions): Promise<BlockBlobPutBlobFromUrlResponse>

Parametreler

sourceURL: string

options: BlockBlobSyncUploadFromURLOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<BlockBlobPutBlobFromUrlResponse>

upload(RequestBodyType, number, BlockBlobUploadOptions)

Yeni bir blok blobu oluşturur veya mevcut blok blobunun içeriğini güncelleştirir. Mevcut bir blok blobunun güncelleştirilmesi, blob üzerindeki mevcut meta verilerin üzerine yazılır. Kısmi güncelleştirmeler desteklenmez; Mevcut blobun içeriğinin üzerine yeni içerik yazılır. Blok bloblarının kısmi güncelleştirmesini gerçekleştirmek için stageBlock kullanın ve commitBlockList.

Bu paralel olmayan bir karşıya yükleme yöntemidir, eşzamanlılık yüklemesinde daha iyi performans için lütfen uploadFilekullanın uploadStream veya uploadBrowserData.

Bkz. https://docs.microsoft.com/rest/api/storageservices/put-blob

function upload(body: RequestBodyType, contentLength: number, options?: BlockBlobUploadOptions): Promise<BlockBlobUploadResponse>

Parametreler

body: HttpRequestBody

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

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: BlockBlobUploadOptions

Blok Blobu Karşıya Yükleme işleminin seçenekleri.

Döndürülenler

Promise<BlockBlobUploadResponse>

Blok Blobu Karşıya Yükleme işlemi için yanıt verileri.

Örnek kullanım:

const content = "Hello world!";
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Uyarı

Bu API artık kullanım dışıdır.

Use uploadData instead.

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

Blok blobu için bir tarayıcı Blobu/Dosyası/ArrayBuffer/ArrayBufferView nesnesini karşıya yükler.

Arabellek uzunluğu 256 MB'tan küçük veya buna eşit olduğunda, bu yöntem karşıya yüklemeyi tamamlamak için 1 karşıya yükleme çağrısı kullanır. Aksi takdirde, bu yöntem blokları karşıya yüklemek için stageBlock çağırır ve son olarak blok listesini işlemek için commitBlockList çağırır.

Ayarlamaya yönelik yaygın blobHTTPHeaders seçeneği blobContentType, tarayıcının dosya türüne göre işlevsellik sağlamasına olanak tanır.

function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Parametreler

browserData: Blob | ArrayBuffer | ArrayBufferView

Blob, Dosya, ArrayBuffer veya ArrayBufferView

options: BlockBlobParallelUploadOptions

Tarayıcı verilerini karşıya yükleme seçenekleri.

Döndürülenler

Promise<BlobUploadCommonResponse>

Blob Karşıya Yükleme işlemi için yanıt verileri.

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

Buffer(Node.js)/Blob(tarayıcılar)/ArrayBuffer/ArrayBufferView nesnesini BlockBlob'a yükler.

Veri uzunluğu belirtilen maxSingleShotSize (varsayılan değer <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>) değerinden farklı olmadığında, bu yöntem karşıya yüklemeyi tamamlamak için 1 karşıya yükleme çağrısı kullanır. Aksi takdirde, bu yöntem blokları karşıya yüklemek için stageBlock çağırır ve son olarak blok listesini işlemek için commitBlockList çağırır.

Ayarlamaya yönelik yaygın blobHTTPHeaders seçeneği blobContentType, tarayıcının dosya türüne göre işlevsellik sağlamasına olanak tanır.

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

Parametreler

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node.js), Blob, ArrayBuffer veya ArrayBufferView

options: BlockBlobParallelUploadOptions

Döndürülenler

Promise<BlobUploadCommonResponse>

uploadFile(string, BlockBlobParallelUploadOptions)

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

Bloklar halinde yerel bir dosyayı blok bloba yükler.

Dosya boyutu 256 MB'tan küçük veya buna eşit olduğunda, bu yöntem karşıya yüklemeyi tamamlamak için 1 karşıya yükleme çağrısı kullanır. Aksi takdirde, bu yöntem blokları karşıya yüklemek için stageBlock'u çağırır ve son olarak blok listesini işlemek için commitBlockList öğesini çağırır.

function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Parametreler

filePath: string

Yerel dosyanın tam yolu

options: BlockBlobParallelUploadOptions

Blok Blobu işlemine karşıya yükleme seçenekleri.

Döndürülenler

Promise<BlobUploadCommonResponse>

Blob Karşıya Yükleme işlemi için yanıt verileri.

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

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

Node.js Okunabilir bir akışı blok blobuna yükler.

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, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions): Promise<BlobUploadCommonResponse>

Parametreler

stream: Readable

Okunabilir akışı Node.js

bufferSize: number

Ayrılan her arabelleğin boyutu, ayrıca karşıya yüklenen blok blobundaki blok boyutu. Varsayılan değer 8 MB'tır

maxConcurrency: number

Maksimum eşzamanlılık, ayrılabilecek en fazla arabellek sayısını, maksimum karşıya yükleme eşzamanlılığı ile pozitif bağıntıyı gösterir. Varsayılan değer 5'tir

options: BlockBlobUploadStreamOptions

Blok Blobu işlemine Akış Yükleme seçenekleri.

Döndürülenler

Promise<BlobUploadCommonResponse>

Blob Karşıya Yükleme işlemi için yanıt verileri.

withSnapshot(string)

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

function withSnapshot(snapshot: string): BlockBlobClient

Parametreler

snapshot: string

Anlık görüntü zaman damgası.

Döndürülenler

BlockBlobClient

Kaynakla aynı ancak belirtilen anlık görüntü zaman damgasına sahip yeni bir BlockBlobClient nesnesi.

Devralınan Yöntemin Ayrıntıları

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Bekleyen bir zaman uyumsuz Kopyalama Blobu işlemini durdurur ve sıfır uzunlukta ve tam meta veri içeren bir hedef blob bırakır. Sürüm 2012-02-12 ve daha yeni.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>

Parametreler

copyId: string

URL'den Kopyala işleminin kimliği.

options: BlobAbortCopyFromURLOptions

Blob Url'den Kopyalamayı Durdur işlemi için isteğe bağlı seçenekler.

Döndürülenler

Promise<BlobAbortCopyFromURLResponse>

BlobClient.abortCopyFromURL Devralınmış

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Blobu zaman uyumsuz olarak depolama hesabı içindeki bir hedefe kopyalar. Bu yöntem, kopya tamamlanana kadar süresiz olarak beklemenize olanak tanıyan uzun süre çalışan bir işlem poller döndürür. Ayrıca, bir kopya tamamlanmadan önce poller üzerindeki cancelOperation çağırarak da iptal edebilirsiniz. İlk istekte işlem tamamlanırsa onProgress geri çağırmasının çağrılmadığını ve tamamlanmış bir kopyanın iptal edilmeye çalışılmasının hataya neden olacağını unutmayın.

Sürüm 2012-02-12 ve sonraki sürümlerde, Blobu Kopyalama işleminin kaynağı herhangi bir Azure depolama hesabında kaydedilmiş bir blob olabilir. 2015-02-21 sürümünden başlayarak, Blobu Kopyalama işleminin kaynağı herhangi bir Azure depolama hesabındaki bir Azure dosyası olabilir. Yalnızca 7 Haziran 2012 veya sonrasında oluşturulan depolama hesapları, Blobu Kopyala işleminin başka bir depolama hesabından kopyalamasına izin verir.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob

Otomatik yoklama kullanma örneği:

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

El ile yoklama kullanma örneği:

const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
   await poller.poll();
}
const result = copyPoller.getResult();

İlerleme güncelleştirmelerini kullanan örnek:

const copyPoller = await blobClient.beginCopyFromURL('url', {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  }
});
const result = await copyPoller.pollUntilDone();

Değişen yoklama aralığının (varsayılan 15 saniye) kullanıldığı örnek:

const copyPoller = await blobClient.beginCopyFromURL('url', {
  intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();

Kopyalama iptali kullanma örneği:

const copyPoller = await blobClient.beginCopyFromURL('url');
// cancel operation after starting it.
try {
  await copyPoller.cancelOperation();
  // calls to get the result now throw PollerCancelledError
  await copyPoller.getResult();
} catch (err) {
  if (err.name === 'PollerCancelledError') {
    console.log('The copy was cancelled.');
  }
}

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions): Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

Parametreler

copySource: string

kaynak Azure Blobu/Dosyası url'si.

options: BlobBeginCopyFromURLOptions

Blob Başlangıç URL'sinden Kopyalama işleminin isteğe bağlı seçenekleri.

Döndürülenler

Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

BlobClient.beginCopyFromURL Devralınmış

createSnapshot(BlobCreateSnapshotOptions)

Blobun salt okunur anlık görüntüsünü oluşturur.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob

function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>

Parametreler

options: BlobCreateSnapshotOptions

Blob Anlık Görüntü Oluştur işlemi için isteğe bağlı seçenekler.

Döndürülenler

Promise<BlobCreateSnapshotResponse>

BlobClient.createSnapshotDevralındı

delete(BlobDeleteOptions)

Belirtilen blobu veya anlık görüntüyü silinmek üzere işaretler. Blob daha sonra çöp toplama sırasında silinir. Bir blobu silmek için tüm anlık görüntülerini silmeniz gerektiğini unutmayın. Blobu Sil işlemiyle ikisini de aynı anda silebilirsiniz.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>

Parametreler

options: BlobDeleteOptions

Blob Silme işlemi için isteğe bağlı seçenekler.

Döndürülenler

Promise<BlobDeleteResponse>

BlobClient.delete'den Devralınmış

deleteIfExists(BlobDeleteOptions)

Varsa, belirtilen blobu veya anlık görüntüyü silinmek üzere işaretler. Blob daha sonra çöp toplama sırasında silinir. Bir blobu silmek için tüm anlık görüntülerini silmeniz gerektiğini unutmayın. Blobu Sil işlemiyle ikisini de aynı anda silebilirsiniz.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>

Parametreler

options: BlobDeleteOptions

Blob Silme işlemi için isteğe bağlı seçenekler.

Döndürülenler

Promise<BlobDeleteIfExistsResponse>

BlobClient.deleteIfExists'dan Devralınan

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Blobdaki değişmezlik ilkesini silin.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>

Parametreler

options: BlobDeleteImmutabilityPolicyOptions

Blobdaki değişmezlik ilkesini silmek için isteğe bağlı seçenekler.

Döndürülenler

Promise<BlobDeleteImmutabilityPolicyResponse>

BlobClient.deleteImmutabilityPolicy devralınan

download(number, number, BlobDownloadOptions)

Meta verileri ve özellikleri dahil olmak üzere bir blobu sistemden okur veya indirir. Anlık görüntüyü okumak için Blob Al'ı da çağırabilirsiniz.

Node.js'de veriler okunabilir bir akışta döndürülebilirStreamBody içinde döndürülüyor
Tarayıcılarda veriler promise blobBody içinde döndürülüyor

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob

function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

Parametreler

offset: number

Blobun 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: BlobDownloadOptions

Blob İndirme işlemi için isteğe bağlı seçenekler.

Örnek kullanım (Node.js):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob content:", downloaded.toString());

async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
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ı):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
  "Downloaded blob content",
  downloaded
);

async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

Döndürülenler

Promise<BlobDownloadResponseParsed>

BlobClient.downloadDevralındı

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

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

Arabelleğe paralel olarak bir Azure Blobu indirir. Uzaklık ve sayı isteğe bağlıdır, sağlanmazsa blob'un tamamını indirir.

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 büyük bloblar için downloadToFilegöz önünde bulundurun.

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

Parametreler

buffer: Buffer

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

offset: number

Blok blobunun indirilmesi gereken konumdan (bayt cinsinden)

count: number

ne kadar veri (bayt cinsinden) indirilecek. Undefined geçirirken sonuna indirilir

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Döndürülenler

Promise<Buffer>

BlobClient.downloadToBuffer'dan Devralınan

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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

Arabelleğe paralel olarak bir Azure Blobu indirir. Uzaklık ve sayı isteğe bağlıdır, sağlanmazsa blob'un tamamını indirir.

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

Parametreler

offset: number

Blok blobunun indirilmesi gereken konumdan (bayt cinsinden)

count: number

ne kadar veri (bayt cinsinden) indirilecek. Undefined geçirirken sonuna indirilir

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Döndürülenler

Promise<Buffer>

BlobClient.downloadToBuffer'dan Devralınan

downloadToFile(string, number, number, BlobDownloadOptions)

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?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

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: BlobDownloadOptions

Blob indirme seçenekleri seçenekleri.

Döndürülenler

Promise<BlobDownloadResponseParsed>

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

BlobClient.downloadToFile'dan Devralınan

exists(BlobExistsOptions)

Bu istemci tarafından temsil edilen Azure blob kaynağı varsa true döndürür; false olarak ayarlayın.

NOT: Mevcut bir blob 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 bloblar eklenebilir.

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

Parametreler

options: BlobExistsOptions

seçeneklerine tıklayın.

Döndürülenler

Promise<boolean>

BlobClient'dan Devralınan

generateSasUrl(BlobGenerateSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle yapılan BlobClient için kullanılabilir.

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

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: BlobGenerateSasUrlOptions): Promise<string>

Parametreler

options: BlobGenerateSasUrlOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<string>

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

BlobClient.generateSasUrlDevralındı

getAccountInfo(BlobGetAccountInfoOptions)

Hesap Bilgilerini Al işlemi, belirtilen hesap için sku adını ve hesap türünü döndürür. Hesap Bilgilerini Al işlemi, sürüm 2018-03-28 ile başlayan hizmet sürümlerinde kullanılabilir.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information

function getAccountInfo(options?: BlobGetAccountInfoOptions): Promise<BlobGetAccountInfoResponse>

Parametreler

options: BlobGetAccountInfoOptions

Hizmet Hesap Bilgilerini Al işleminin seçenekleri.

Döndürülenler

Promise<BlobGetAccountInfoResponse>

Hizmet Hesap Bilgilerini Al işlemi için yanıt verileri.

BlobClient.getAccountInfoDevralındı

getAppendBlobClient()

AppendBlobClient nesnesi oluşturur.

function getAppendBlobClient(): AppendBlobClient

Döndürülenler

AppendBlobClient

BlobClient.getAppendBlobClientDevralındı

getBlobLeaseClient(string)

Blob üzerindeki kiraları yöneten bir BlobLeaseClient alın.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parametreler

proposeLeaseId: string

İlk önerilen kira kimliği.

Döndürülenler

BlobLeaseClient

Blob üzerindeki kiraları yönetmek için yeni bir BlobLeaseClient nesnesi.

BlobClient.getBlobLeaseClientDevralındı

getBlockBlobClient()

BlockBlobClient nesnesi oluşturur.

function getBlockBlobClient(): BlockBlobClient

Döndürülenler

BlockBlobClient

BlobClient.getBlockBlobClientDevralındı

getPageBlobClient()

PageBlobClient nesnesi oluşturur.

function getPageBlobClient(): PageBlobClient

Döndürülenler

PageBlobClient

BlobClient.getPageBlobClient Devralınmış

getProperties(BlobGetPropertiesOptions)

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

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

UYARI: Yanıtta döndürülen metadata nesnesinin anahtarları başlangıçta büyük harf karakterler içerse bile küçük harfle gösterilir. Bu, özgün büyük/küçük harflerini koruyacak includeMetadata seçeneğini kullanarak blobları listeleyen ContainerClient yöntemleri tarafından döndürülen meta veri anahtarlarından farklıdır.

function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>

Parametreler

options: BlobGetPropertiesOptions

Özellikleri Al işlemi için isteğe bağlı seçenekler.

Döndürülenler

Promise<BlobGetPropertiesResponse>

BlobClient.getPropertiesDevralındı

getTags(BlobGetTagsOptions)

Temel alınan blobla ilişkili etiketleri alır.

function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>

Parametreler

options: BlobGetTagsOptions

Döndürülenler

Promise<BlobGetTagsResponse>

BlobClient.getTagsDevralındı

setAccessTier(string, BlobSetTierOptions)

Blob üzerindeki katmanı ayarlar. İşleme premium depolama hesabındaki bir sayfa blobunda ve blob depolama hesabındaki bir blok blobunda izin verilir (yalnızca yerel olarak yedekli depolama). Premium sayfa blobunun katmanı blobun izin verilen boyutunu, IOPS'sini ve bant genişliğini belirler. Blok blobu katmanı Sık Erişimli/Seyrek Erişimli/Arşiv depolama türünü belirler. Bu işlem blob'un ETag'ini güncelleştirmez.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier

function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>

Parametreler

tier: string

Blobda ayarlanacak katman. Geçerli değerler Sık Erişimli, Seyrek Erişimli veya Arşiv'tir.

options: BlobSetTierOptions

Blob Kümesi Katmanı işlemi için isteğe bağlı seçenekler.

Döndürülenler

Promise<BlobSetTierResponse>

BlobClient.setAccessTierDevralındı

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Blob üzerindeki sistem özelliklerini ayarlar.

Belirtilen blob HTTP üst bilgileri için değer sağlanmazsa veya değer sağlanmazsa, değeri olmayan bu blob HTTP üst bilgileri temizlenir.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>

Parametreler

blobHTTPHeaders: BlobHTTPHeaders

Belirtilen blob HTTP üst bilgileri için değer sağlanmazsa veya değer sağlanmazsa, değeri olmayan bu blob HTTP üst bilgileri temizlenir. Tarayıcının dosya türüne göre işlevsellik sağlaması blobContentType ortak bir üst bilgi ayarlanır.

options: BlobSetHTTPHeadersOptions

Blob Küme HTTP Üst Bilgileri işlemi için isteğe bağlı seçenekler.

Döndürülenler

Promise<BlobSetHTTPHeadersResponse>

BlobClient.sethttpHeadersDevralındı

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Blob üzerinde değişmezlik ilkesini ayarlayın.

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>

Parametreler

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

Blob üzerinde değişmezlik ilkesini ayarlamak için isteğe bağlı seçenekler.

Döndürülenler

Promise<BlobSetImmutabilityPolicyResponse>

BlobClient.setImmutabilityPolicy devralınmış

setLegalHold(boolean, BlobSetLegalHoldOptions)

Blob üzerinde yasal saklama ayarlayın.

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>

Parametreler

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

Blob üzerinde yasal saklamayı ayarlamak için isteğe bağlı seçenekler.

Döndürülenler

Promise<BlobSetLegalHoldResponse>

BlobClient.setLegalHoldDevralındı

setMetadata(Metadata, BlobSetMetadataOptions)

Belirtilen blob için kullanıcı tanımlı meta verileri bir veya daha fazla ad-değer çifti olarak ayarlar.

Seçenek sağlanmadıysa veya parametrede tanımlı meta veri yoksa blob meta verileri kaldırılır.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>

Parametreler

metadata: Metadata

Var olan meta verileri bu değerle değiştirin. Değer sağlanmazsa, mevcut meta veriler kaldırılır.

options: BlobSetMetadataOptions

Meta Veri Ayarlama işlemi için isteğe bağlı seçenekler.

Döndürülenler

Promise<BlobSetMetadataResponse>

BlobClient.setMetadataDevralındı

setTags(Tags, BlobSetTagsOptions)

Temel alınan blob üzerindeki etiketleri ayarlar. Bir blobda en fazla 10 etiket olabilir. Etiket anahtarları 1 ile 128 karakter arasında olmalıdır. Etiket değerleri 0 ile 256 karakter arasında olmalıdır. Geçerli etiket anahtarı ve değer karakterleri küçük ve büyük harf, basamak (0-9), boşluk (' '), artı ('+'), eksi ('-'), nokta ('.'), eğik çizgi ('/'), iki nokta üst üste (':'), eşittir ('=') ve alt çizgi ('_') içerir.

function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>

Parametreler

tags: Tags

options: BlobSetTagsOptions

Döndürülenler

Promise<BlobSetTagsResponse>

BlobClient.setTagsDevralındı

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

Zaman uyumlu URL'den Kopyala işlemi bir blobu veya İnternet kaynağını yeni bir bloba kopyalar. Kopya tamamlanana kadar yanıt döndürmez.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>

Parametreler

copySource: string

Kopyalanacak kaynak URL, Kimlik doğrulaması için paylaşılan erişim imzası (SAS) gerekebilir

options: BlobSyncCopyFromURLOptions

Döndürülenler

Promise<BlobCopyFromURLResponse>

BlobClient.syncCopyFromURLDevralındı

undelete(BlobUndeleteOptions)

Geçici olarak silinen blobun içeriğini ve meta verilerini ve ilişkili geçici silinen anlık görüntüleri geri yükler. Blobu Geri Alma yalnızca 2017-07-29 veya sonraki bir sürümde desteklenir.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob

function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>

Parametreler

options: BlobUndeleteOptions

Blob Silme işleminin isteğe bağlı seçenekleri.

Döndürülenler

Promise<BlobUndeleteResponse>

BlobClient.undeleteDevralındı

withVersion(string)

Bu blobun bir sürümünü işaret eden yeni bir BlobClient nesnesi oluşturur. "" değerini sağlayın, versionId değerini kaldırır ve temel bloba bir İstemci döndürür.

function withVersion(versionId: string): BlobClient

Parametreler

versionId: string

versionId.

Döndürülenler

BlobClient

Bu blobun sürümüne işaret eden yeni bir BlobClient nesnesi.

BlobClient.withVersionDevralındı

Aracılığıyla paylaş

BlockBlobClient class

Oluşturucular

Özellikler

Devralınan Özellikler

Yöntemler

Devralınan Yöntemler

Oluşturucu Ayrıntıları

BlockBlobClient(string, PipelineLike)

Parametreler

BlockBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Parametreler

BlockBlobClient(string, string, string, StoragePipelineOptions)

Parametreler

Özellik Ayrıntıları

containerName

Özellik Değeri

name

Özellik Değeri

Devralınan Özellik Detayları

accountName

Özellik Değeri

credential

Özellik Değeri

url

Özellik Değeri

Yöntem Ayrıntıları

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Parametreler

Döndürülenler

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

Parametreler

Döndürülenler

query(string, BlockBlobQueryOptions)

Parametreler

Döndürülenler

stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

Parametreler

Döndürülenler

stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)

Parametreler

Döndürülenler

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Parametreler

Döndürülenler

upload(RequestBodyType, number, BlockBlobUploadOptions)

Parametreler

Döndürülenler

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Parametreler

Döndürülenler

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

Parametreler

Döndürülenler

uploadFile(string, BlockBlobParallelUploadOptions)

Parametreler

Döndürülenler

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

Parametreler

Döndürülenler

withSnapshot(string)

Parametreler

Döndürülenler

Devralınan Yöntemin Ayrıntıları

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Parametreler

Döndürülenler

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Parametreler

Döndürülenler

createSnapshot(BlobCreateSnapshotOptions)

Parametreler

Döndürülenler

delete(BlobDeleteOptions)

Parametreler

Döndürülenler

deleteIfExists(BlobDeleteOptions)

Parametreler

Döndürülenler

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)