BlobClient class

Başvuru

Paket:: @azure/storage-blob

BlobClient, Azure Depolama blobu URL'sini temsil eder; blob bir blok blobu, ekleme blobu veya sayfa blobu olabilir.

Extends: StorageClient

Oluşturucular

BlobClient(string, PipelineLike)	BlobClient'ın bir örneğini oluşturur. 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. Blob adından biri varsa? veya %blob adı URL'de kodlanmalıdır.
BlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	BlobClient'ın bir örneğini oluşturur. 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. Blob adından biri varsa? veya %blob adı URL'de kodlanmalıdır.
BlobClient(string, string, string, StoragePipelineOptions)	Bağlantı dizesinden bir BlobClient ö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

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
withSnapshot(string)	Kaynakla aynı ancak belirtilen anlık görüntü zaman damgasıyla yeni bir BlobClient nesnesi oluşturur. "" değerini sağlayın, anlık görüntüyü kaldırır ve temel bloba bir İstemci döndürür.
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ı

BlobClient(string, PipelineLike)

BlobClient'ın bir örneğini oluşturur. 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. Blob adından biri varsa? veya %blob adı URL'de kodlanmalıdır.

new BlobClient(url: string, pipeline: PipelineLike)

Parametreler

url: string

Azure Depolama blobu'na işaret eden "https://myaccount.blob.core.windows.net/mycontainer/blob" gibi bir URL dizesi. AnonymousCredential kullanıyorsanız , "https://myaccount.blob.core.windows.net/mycontainer/blob?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.

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

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

Parametreler

url: string

"https://myaccount.blob.core.windows.net" gibi Azure Depolama blob hizmetine işaret eden bir İstemci dizesi. AnonymousCredential kullanıyorsanız , "https://myaccount.blob.core.windows.net?sasString" gibi bir SAS ekleyebilirsiniz.

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.

BlobClient(string, string, string, StoragePipelineOptions)

Bağlantı dizesinden bir BlobClient örneği oluşturur.

new BlobClient(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

StorageClient.accountName'den Devralınan

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Özellik Değeri

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

StorageClient.credential'dan Devralınmış

url

Kodlanmış URL dizesi değeri.

url: string

Özellik Değeri

string

StorageClient.url'den Devralınan

Yöntem 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>

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

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>

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>

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>

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>

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>

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>

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>

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

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>

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.

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.

getAppendBlobClient()

AppendBlobClient nesnesi oluşturur.

function getAppendBlobClient(): AppendBlobClient

Döndürülenler

AppendBlobClient

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.

getBlockBlobClient()

BlockBlobClient nesnesi oluşturur.

function getBlockBlobClient(): BlockBlobClient

Döndürülenler

BlockBlobClient

getPageBlobClient()

PageBlobClient nesnesi oluşturur.

function getPageBlobClient(): PageBlobClient

Döndürülenler

PageBlobClient

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

withSnapshot(string)

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

function withSnapshot(snapshot: string): BlobClient

Parametreler

snapshot: string

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

Döndürülenler

BlobClient

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

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.

Aracılığıyla paylaş

BlobClient class

Oluşturucular

Özellikler

Devralınan Özellikler

Yöntemler

Oluşturucu Ayrıntıları

BlobClient(string, PipelineLike)

Parametreler

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

Parametreler

BlobClient(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ı

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)

Parametreler

Döndürülenler

download(number, number, BlobDownloadOptions)

Parametreler

Döndürülenler

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

Parametreler

Döndürülenler

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

Parametreler

Döndürülenler

downloadToFile(string, number, number, BlobDownloadOptions)

Parametreler

Döndürülenler

exists(BlobExistsOptions)

Parametreler

Döndürülenler

generateSasUrl(BlobGenerateSasUrlOptions)

Parametreler

Döndürülenler

getAccountInfo(BlobGetAccountInfoOptions)

Parametreler

Döndürülenler

getAppendBlobClient()

Döndürülenler

getBlobLeaseClient(string)

Parametreler

Döndürülenler

getBlockBlobClient()

Döndürülenler

getPageBlobClient()

Döndürülenler

getProperties(BlobGetPropertiesOptions)

Parametreler

Döndürülenler

getTags(BlobGetTagsOptions)

Parametreler

Döndürülenler