Share via

PageBlobClient class

  • Başvuru
Paket:
@azure/storage-blob

PageBlobClient, sayfa blobları için geçerli olan bir dizi işlemi tanımlar.

Extends
BlobClient

Oluşturucular

PageBlobClient(string, PipelineLike)

PageBlobClient örneğini oluşturur.
PageBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

PageBlobClient örneğini oluşturur. Bu yöntem, bir bloba işaret eden kodlanmış url'yi veya kodlanmamış URL'yi kabul eder. Kodlanmış URL dizesi iki kez kaçılmaz, yalnızca URL yolundaki özel karakterlerden kaçış karakteri kullanılır. Blob adında ? varsa veya %, blob adı URL'de kodlanmalıdır.
PageBlobClient(string, string, string, StoragePipelineOptions)

PageBlobClient örneğini 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 veya hizmete yönelik isteklerin @azure/identity kimliğini doğrulamak için paketten herhangi bir kimlik bilgisi gibi. TokenCredential arabirimini uygulayan bir nesne de sağlayabilirsiniz. Belirtilmezse, AnonymousCredential kullanılır.
url

Kodlanmış URL dizesi değeri.

Yöntemler

clearPages(number, number, PageBlobClearPagesOptions)

Belirtilen sayfaları sayfa blobundan serbest kaldırır.

Bkz. https://docs.microsoft.com/rest/api/storageservices/put-page
create(number, PageBlobCreateOptions)

Belirtilen uzunlukta bir sayfa blobu oluşturur. Veri verilerini bir sayfa blob'una yüklemek için uploadPages çağrısında bulunur.

Bkz. https://docs.microsoft.com/rest/api/storageservices/put-blob
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Belirtilen uzunlukta bir sayfa blobu oluşturur. Veri verilerini bir sayfa blob'una yüklemek için uploadPages çağrısında bulunur. Aynı ada sahip blob zaten varsa, mevcut blobun içeriği değişmeden kalır.

Bkz. https://docs.microsoft.com/rest/api/storageservices/put-blob
getPageRanges(number, number, PageBlobGetPageRangesOptions)

Sayfa blobu veya sayfa blobunun anlık görüntüsü için geçerli sayfa aralıklarının listesini döndürür.

Bkz. https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

Belirtilen anlık görüntü ile bu sayfa blobu arasında farklılık gösteren sayfa aralıkları koleksiyonunu alır.

Bkz. https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

Yönetilen diskler için belirtilen anlık görüntü ile bu sayfa blobu arasında farklılık gösteren sayfa aralıkları koleksiyonunu alır.

Bkz. https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
listPageRanges(number, number, PageBlobListPageRangesOptions)

Sayfa blobu için sayfa aralıklarının listesine zaman uyumsuz yinelenebilir bir yineleyici döndürür.

Bkz. https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() bir sayfa blobu için sayfa aralıklarının listesi için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

Söz dizimi kullanan for await örnek:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

kullanan iter.next()örnek:

let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

kullanan byPage()örnek:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

İşaretçi ile disk belleği kullanma örneği:

let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

Belirtilen anlık görüntü ile bu sayfa blobu arasında farklılık gösteren sayfa aralıklarını listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür.

Bkz. https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() belirtilen anlık görüntü ile bu sayfa blobu arasında farklılık gösteren sayfa aralıklarının listesi için zaman uyumsuz yinelenebilir bir yineleyici döndürür.

Söz dizimi kullanan for await örnek:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

kullanan iter.next()örnek:

let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

kullanan byPage()örnek:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

İşaretçi ile disk belleği kullanma örneği:

let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
resize(number, PageBlobResizeOptions)

Sayfa blobunu belirtilen boyuta (512'nin katı olmalıdır) yeniden boyutlandırıyor.

Bkz. https://docs.microsoft.com/rest/api/storageservices/set-blob-properties
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

Bir sayfa blob'un anlık görüntüsünden bu sayfa blob'una artımlı bir kopya başlatma işlemini başlatır. Anlık görüntü, yalnızca daha önce kopyalanan anlık görüntü arasındaki değişiklik değişiklikleri hedefe aktarılacak şekilde kopyalanır. Kopyalanan anlık görüntüler özgün anlık görüntünün tam kopyalarıdır ve her zamanki gibi okunabilir veya kopyalanabilir.

Bkz.https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blobhttps://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Sayfa blob'larının sıra numarasını ayarlar.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

Sayfa blob'una 1 veya daha fazla sayfa yazar. Başlangıç ve bitiş uzaklıkları 512'nin katı olmalıdır.

Bkz. https://docs.microsoft.com/rest/api/storageservices/put-page
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

Sayfaları Karşıya Yükle işlemi, içeriğin bir URL'den okunduğu sayfa blob'una bir sayfa aralığı yazar.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/put-page-from-url
withSnapshot(string)

Kaynakla aynı ancak belirtilen anlık görüntü zaman damgasıyla yeni bir PageBlobClient 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.

Devralınan Yöntemler

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Bekleyen zaman uyumsuz Bir Blob Kopyalama 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ındaki bir hedefe kopyalar. Bu yöntem, kopyalama tamamlanana kadar süresiz olarak beklemenizi sağlayan uzun süre çalışan bir işlem poller döndürür. Ayrıca, bir kopyayı tamamlanmadan önce poller üzerinde çağırarak cancelOperation 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 bir hata oluştuğuna dikkat edin.

Sürüm 2012-02-12 ve sonraki sürümlerde, Blob Kopyalama işleminin kaynağı herhangi bir Azure depolama hesabında yürütülen bir blob olabilir. 2015-02-21 sürümünden başlayarak, Blob 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 Kopyalama 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 kullanma örneği:

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 kullanıldığı örnek (varsayılan 15 saniye):

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

Kopyalama iptali ö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)

Belirtilen blobu veya anlık görüntüyü varsa 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)

Blob üzerindeki değişmezlik ilkesini silin.
download(number, number, BlobDownloadOptions)

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

  • Node.js'da veriler Okunabilir bir akışta readableStreamBody 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ğlanmıyorsa blob'un tamamını indirir.

Uyarı: Arabellekler, Node.js/V8 sınırlamaları nedeniyle yalnızca 32 bit sistemlerde yaklaşık bir gigabayt veya 64 bit sistemlerde yaklaşık iki gigabayt kadar dosyaları destekleyebilir. Bu boyuttan daha büyük bloblar için downloadToFile'ı gö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ğlanmıyorsa blob'un tamamını indirir.

Uyarı: Arabellekler, Node.js/V8 sınırlamaları nedeniyle yalnızca 32 bit sistemlerde yaklaşık bir gigabayt veya 64 bit sistemlerde yaklaşık iki gigabayt kadar dosyaları destekleyebilir. Bu boyuttan daha büyük bloblar için downloadToFile'ı göz önünde bulundurun.
downloadToFile(string, number, number, BlobDownloadOptions)

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

Azure Blob'larını yerel bir dosyaya indirir. Verilen dosya yolu zaten çıkarsa başarısız olur. Göreli konum 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
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 metadata döndürülen nesnenin 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 olan seçeneğini kullanarak includeMetadata 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 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.

Değer sağlanmazsa veya belirtilen blob HTTP üst bilgileri için 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ğlanmazsa veya parametresinde 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 blobdaki 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 olarak silinen anlık görüntüleri geri yükler. Blob'u geri alma işlemi yalnızca 2017-07-29 veya sonraki sürümlerde 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ı

PageBlobClient(string, PipelineLike)

PageBlobClient örneğini oluşturur.

new PageBlobClient(url: string, pipeline: PipelineLike)

Parametreler

url

string

Azure Depolama sayfa blobu'na işaret eden "https://myaccount.blob.core.windows.net/mycontainer/pageblob" gibi bir URL dizesi. AnonymousCredential kullanıyorsanız SAS ekleyebilirsiniz; örneğin, "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString". Bu yöntem, bir bloba işaret eden kodlanmış url'yi veya kodlanmamış URL'yi kabul eder. Kodlanmış URL dizesi iki kez kaçılmaz, yalnızca URL yolundaki özel karakterlerden kaçış karakteri kullanılır. Ancak blob adında ? varsa 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.

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

PageBlobClient örneğini oluşturur. Bu yöntem, bir bloba işaret eden kodlanmış url'yi veya kodlanmamış URL'yi kabul eder. Kodlanmış URL dizesi iki kez kaçılmaz, yalnızca URL yolundaki özel karakterlerden kaçış karakteri kullanılır. Blob adında ? varsa veya %, blob adı URL'de kodlanmalıdır.

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

Parametreler

url

string

Azure Depolama sayfa blobu'na işaret eden "https://myaccount.blob.core.windows.net/mycontainer/pageblob" gibi bir İstemci dizesi. AnonymousCredential kullanıyorsanız SAS ekleyebilirsiniz; örneğin, "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options
StoragePipelineOptions

İsteğe bağlı. HTTP işlem hattını yapılandırma seçenekleri.

PageBlobClient(string, string, string, StoragePipelineOptions)

PageBlobClient örneğini oluşturur.

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

Parametreler

connectionString

string

Hesap bağlantı dizesi veya Azure depolama hesabının 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 -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS bağlantı dizesi örneği - 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

İsteğe bağlı. 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.accountName'denDevralındı

credential

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Özellik Değeri

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

BlobClient.credential'danDevralındı

url

Kodlanmış URL dizesi değeri.

url: string

Özellik Değeri

string

BlobClient.url'denDevralındı

Yöntem Ayrıntıları

clearPages(number, number, PageBlobClearPagesOptions)

Belirtilen sayfaları sayfa blobundan serbest kaldırır.

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

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions): Promise<PageBlobClearPagesResponse>

Parametreler

offset

number

Sayfaların temizlenmek üzere bayt konumu başlatılıyor.

count

number

Temizlenecek bayt sayısı.

options
PageBlobClearPagesOptions

Sayfa Blobu Sayfaları Temizle işleminin seçenekleri.

Döndürülenler

Promise<PageBlobClearPagesResponse>

Sayfa Blobu Sayfaları Temizle işlemi için yanıt verileri.

create(number, PageBlobCreateOptions)

Belirtilen uzunlukta bir sayfa blobu oluşturur. Veri verilerini bir sayfa blob'una yüklemek için uploadPages çağrısında bulunur.

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

function create(size: number, options?: PageBlobCreateOptions): Promise<PageBlobCreateResponse>

Parametreler

size

number

sayfa blobunun boyutu.

options
PageBlobCreateOptions

Sayfa Blobu Oluşturma işleminin seçenekleri.

Döndürülenler

Promise<PageBlobCreateResponse>

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

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Belirtilen uzunlukta bir sayfa blobu oluşturur. Veri verilerini bir sayfa blob'una yüklemek için uploadPages çağrısında bulunur. Aynı ada sahip blob zaten varsa, mevcut blobun içeriği değişmeden kalır.

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

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions): Promise<PageBlobCreateIfNotExistsResponse>

Parametreler

size

number

sayfa blobunun boyutu.

options
PageBlobCreateIfNotExistsOptions

Döndürülenler

Promise<PageBlobCreateIfNotExistsResponse>

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Sayfa blobu veya sayfa blobunun anlık görüntüsü için geçerli sayfa aralıklarının listesini döndürür.

Bkz. https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions): Promise<PageBlobGetPageRangesResponse>

Parametreler

offset

number

Sayfa aralıklarının başlangıç bayt konumu.

count

number

Elde edilecek bayt sayısı.

options
PageBlobGetPageRangesOptions

Sayfa Blobu Aralıkları Al işleminin seçenekleri.

Döndürülenler

Promise<PageBlobGetPageRangesResponse>

Sayfa Blobu Alma Aralıkları işlemi için yanıt verileri.

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

Belirtilen anlık görüntü ile bu sayfa blobu arasında farklılık gösteren sayfa aralıkları koleksiyonunu alır.

Bkz. https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

Parametreler

offset

number

Sayfa blobunun bayt konumunu başlatma

count

number

Aralıkların farkını almak için bayt sayısı.

prevSnapshot

string

Farkı almak için anlık görüntünün zaman damgası.

options
PageBlobGetPageRangesDiffOptions

Sayfa Blobu Sayfa Aralıklarını Al Fark işleminin seçenekleri.

Döndürülenler

Promise<PageBlobGetPageRangesDiffResponse>

Sayfa Blobu Sayfa Aralığını Al Fark işlemi için yanıt verileri.

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

Yönetilen diskler için belirtilen anlık görüntü ile bu sayfa blobu arasında farklılık gösteren sayfa aralıkları koleksiyonunu alır.

Bkz. https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

Parametreler

offset

number

Sayfa blobunun bayt konumunu başlatma

count

number

Aralıkların farkını almak için bayt sayısı.

prevSnapshotUrl

string

Farkı almak için anlık görüntünün URL'si.

options
PageBlobGetPageRangesDiffOptions

Sayfa Blobu Sayfa Aralıklarını Al Fark işleminin seçenekleri.

Döndürülenler

Promise<PageBlobGetPageRangesDiffResponse>

Sayfa Blobu Sayfa Aralığını Al Fark işlemi için yanıt verileri.

listPageRanges(number, number, PageBlobListPageRangesOptions)

Sayfa blobu için sayfa aralıklarının listesine zaman uyumsuz yinelenebilir bir yineleyici döndürür.

Bkz. https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() bir sayfa blobu için sayfa aralıklarının listesi için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

Söz dizimi kullanan for await örnek:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

kullanan iter.next()örnek:

let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

kullanan byPage()örnek:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

İşaretçi ile disk belleği kullanma örneği:

let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

function listPageRanges(offset?: number, count?: number, options?: PageBlobListPageRangesOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

Parametreler

offset

number

Sayfa aralıklarının başlangıç bayt konumu.

count

number

Elde edilecek bayt sayısı.

options
PageBlobListPageRangesOptions

Sayfa Blobu Aralıkları Al işleminin seçenekleri.

Döndürülenler

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

Disk belleğini destekleyen bir asyncIterableIterator.

listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

Belirtilen anlık görüntü ile bu sayfa blobu arasında farklılık gösteren sayfa aralıklarını listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür.

Bkz. https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() belirtilen anlık görüntü ile bu sayfa blobu arasında farklılık gösteren sayfa aralıklarının listesi için zaman uyumsuz yinelenebilir bir yineleyici döndürür.

Söz dizimi kullanan for await örnek:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

kullanan iter.next()örnek:

let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

kullanan byPage()örnek:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

İşaretçi ile disk belleği kullanma örneği:

let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

function listPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobListPageRangesDiffOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

Parametreler

offset

number

Sayfa aralıklarının başlangıç bayt konumu.

count

number

Elde edilecek bayt sayısı.

prevSnapshot

string

Farkı almak için anlık görüntünün zaman damgası.

options
PageBlobListPageRangesDiffOptions

Sayfa Blobu Aralıkları Al işleminin seçenekleri.

Döndürülenler

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

Disk belleğini destekleyen bir asyncIterableIterator.

resize(number, PageBlobResizeOptions)

Sayfa blobunu belirtilen boyuta (512'nin katı olmalıdır) yeniden boyutlandırıyor.

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

function resize(size: number, options?: PageBlobResizeOptions): Promise<PageBlobResizeResponse>

Parametreler

size

number

Hedef boyutu

options
PageBlobResizeOptions

Sayfa Blobunu Yeniden Boyutlandırma işleminin seçenekleri.

Döndürülenler

Promise<PageBlobResizeResponse>

Sayfa Blobu Yeniden Boyutlandırma işlemi için yanıt verileri.

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

Bir sayfa blob'un anlık görüntüsünden bu sayfa blob'una artımlı bir kopya başlatma işlemini başlatır. Anlık görüntü, yalnızca daha önce kopyalanan anlık görüntü arasındaki değişiklik değişiklikleri hedefe aktarılacak şekilde kopyalanır. Kopyalanan anlık görüntüler özgün anlık görüntünün tam kopyalarıdır ve her zamanki gibi okunabilir veya kopyalanabilir.

Bkz.https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blobhttps://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions): Promise<PageBlobCopyIncrementalResponse>

Parametreler

copySource

string

Kaynak sayfa blob anlık görüntüsünün adını belirtir. Örneğin, https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

options
PageBlobStartCopyIncrementalOptions

Sayfa Blobu Kopyalama Artımlı işleminin seçenekleri.

Döndürülenler

Promise<PageBlobCopyIncrementalResponse>

Sayfa Blobu Kopyalama Artımlı işlemi için yanıt verileri.

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Sayfa blob'larının sıra numarasını ayarlar.

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

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions): Promise<PageBlobUpdateSequenceNumberResponse>

Parametreler

sequenceNumberAction
SequenceNumberActionType

Hizmetin blob'un sıra numarasını nasıl değiştirmesi gerektiğini gösterir.

sequenceNumber

number

sequenceNumberAction en yüksek veya güncelleştirme ise gereklidir

options
PageBlobUpdateSequenceNumberOptions

Sayfa Blobu Güncelleştirme Sıra Numarası işleminin seçenekleri.

Döndürülenler

Promise<PageBlobUpdateSequenceNumberResponse>

Sayfa Blobu Güncelleştirme Sıra Numarası işlemi için yanıt verileri.

uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

Sayfa blob'una 1 veya daha fazla sayfa yazar. Başlangıç ve bitiş uzaklıkları 512'nin katı olmalıdır.

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

function uploadPages(body: HttpRequestBody, offset: number, count: number, options?: PageBlobUploadPagesOptions): Promise<PageBlobUploadPagesResponse>

Parametreler

body
HttpRequestBody

Karşıya yüklenecek veriler

offset

number

Hedef sayfa blobunun uzaklığı

count

number

Gövdenin içerik uzunluğu, ayrıca karşıya yüklenecek bayt sayısı

options
PageBlobUploadPagesOptions

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

Döndürülenler

Promise<PageBlobUploadPagesResponse>

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

uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

Sayfaları Karşıya Yükle işlemi, içeriğin bir URL'den okunduğu sayfa blob'una bir sayfa aralığı yazar.

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

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions): Promise<PageBlobUploadPagesFromURLResponse>

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 sayfa blobunun başından kopyalamak için 0 geçirme

destOffset

number

Hedef sayfa blobunun uzaklığı

count

number

Kaynak sayfa blobundan karşıya yüklenecek bayt sayısı

options
PageBlobUploadPagesFromURLOptions

Döndürülenler

Promise<PageBlobUploadPagesFromURLResponse>

withSnapshot(string)

Kaynakla aynı ancak belirtilen anlık görüntü zaman damgasıyla yeni bir PageBlobClient 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): PageBlobClient

Parametreler

snapshot

string

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

Döndürülenler

PageBlobClient

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

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

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Bekleyen zaman uyumsuz Bir Blob Kopyalama 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

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

Döndürülenler

Promise<BlobAbortCopyFromURLResponse>

BlobClient.abortCopyFromURL'denDevralındı

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Blobu zaman uyumsuz olarak depolama hesabındaki bir hedefe kopyalar. Bu yöntem, kopyalama tamamlanana kadar süresiz olarak beklemenizi sağlayan uzun süre çalışan bir işlem poller döndürür. Ayrıca, bir kopyayı tamamlanmadan önce poller üzerinde çağırarak cancelOperation 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 bir hata oluştuğuna dikkat edin.

Sürüm 2012-02-12 ve sonraki sürümlerde, Blob Kopyalama işleminin kaynağı herhangi bir Azure depolama hesabında yürütülen bir blob olabilir. 2015-02-21 sürümünden başlayarak, Blob 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 Kopyalama 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 kullanma örneği:

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 kullanıldığı örnek (varsayılan 15 saniye):

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

Kopyalama iptali ö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şlemi için isteğe bağlı seçenekler.

Döndürülenler

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

BlobClient.beginCopyFromURL'denDevralındı

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şturma işlemi için isteğe bağlı seçenekler.

Döndürülenler

Promise<BlobCreateSnapshotResponse>

BlobClient.createSnapshot'tanDevralı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'denDevralındı

deleteIfExists(BlobDeleteOptions)

Belirtilen blobu veya anlık görüntüyü varsa 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'tenDevralındı

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Blob üzerindeki 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'denDevralındı

download(number, number, BlobDownloadOptions)

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

  • Node.js'da veriler Okunabilir bir akışta readableStreamBody 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 indirilecek, 0'dan büyük. Tanımsız olduğunda sonuna 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.download'tenDevralı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ğlanmıyorsa blob'un tamamını indirir.

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

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

Parametreler

buffer

Buffer

Doldurulacak arabellek, uzunluğu sayıdan büyük olmalıdır

offset

number

Blok blobunun indirilmesi gereken konumdan (bayt cinsinden)

count

number

ne kadar verinin (bayt cinsinden) indirileceği. Undefined geçirilirken sonuna indirilir

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Döndürülenler

Promise<Buffer>

BlobClient.downloadToBuffer'danDevralındı

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ğlanmıyorsa blob'un tamamını indirir.

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

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

Parametreler

offset

number

Blok blobunun indirilmesi gereken konumdan (bayt cinsinden)

count

number

ne kadar verinin (bayt cinsinden) indirileceği. Undefined geçirilirken sonuna indirilir

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Döndürülenler

Promise<Buffer>

BlobClient.downloadToBuffer'danDevralındı

downloadToFile(string, number, number, BlobDownloadOptions)

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

Azure Blob'larını yerel bir dosyaya indirir. Verilen dosya yolu zaten çıkarsa başarısız olur. Göreli konum 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 indirir.

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 okunup belirtilen yolda yerel bir dosyaya yazıldığından readableStreamBody tanımsız olarak ayarlanmıştır.

BlobClient.downloadToFile'danDevralındı

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

mevcut işlem seçeneklerine tıklayın.

Döndürülenler

Promise<boolean>

BlobClient'dan Devralındı.exists

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.generateSasUrl'danDevralındı

getAppendBlobClient()

AppendBlobClient nesnesi oluşturur.

function getAppendBlobClient(): AppendBlobClient

Döndürülenler

AppendBlobClient

BlobClient.getAppendBlobClient'danDevralı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.getBlobLeaseClient'danDevralındı

getBlockBlobClient()

BlockBlobClient nesnesi oluşturur.

function getBlockBlobClient(): BlockBlobClient

Döndürülenler

BlockBlobClient

BlobClient.getBlockBlobClient'danDevralındı

getPageBlobClient()

PageBlobClient nesnesi oluşturur.

function getPageBlobClient(): PageBlobClient

Döndürülenler

PageBlobClient

BlobClient.getPageBlobClient'danDevralındı

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 metadata döndürülen nesnenin 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 olan seçeneğini kullanarak includeMetadata 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.getProperties'tenDevralı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.getTags'denDevralındı

setAccessTier(string, BlobSetTierOptions)

Blob üzerindeki katmanı ayarlar. İşleme premium depolama hesabındaki bir sayfa blobunda ve blob depolama hesabındaki 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 değerleridir.

options
BlobSetTierOptions

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

Döndürülenler

Promise<BlobSetTierResponse>

BlobClient.setAccessTier'danDevralındı

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Blob üzerindeki sistem özelliklerini ayarlar.

Değer sağlanmazsa veya belirtilen blob HTTP üst bilgileri için 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

Değer sağlanmazsa veya belirtilen blob HTTP üst bilgileri için değer sağlanmazsa, değeri olmayan bu blob HTTP üst bilgileri temizlenir. Ayarlanması gereken ortak bir üst bilgi, blobContentType tarayıcının dosya türüne göre işlevsellik sağlamasıdı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.setHTTPHeaders'danDevralı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

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

Döndürülenler

Promise<BlobSetImmutabilityPolicyResponse>

BlobClient.setImmutabilityPolicy'denDevralındı

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 tutma ayarlamak için isteğe bağlı seçenekler.

Döndürülenler

Promise<BlobSetLegalHoldResponse>

BlobClient.setLegalHold'tanDevralı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ğlanmazsa veya parametresinde 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 Verileri Ayarla işlemi için isteğe bağlı seçenekler.

Döndürülenler

Promise<BlobSetMetadataResponse>

BlobClient.setMetadata'danDevralındı

setTags(Tags, BlobSetTagsOptions)

Temel alınan blobdaki 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.setTags'denDevralı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 İmzası (SAS) gerekebilir

options
BlobSyncCopyFromURLOptions

Döndürülenler

Promise<BlobCopyFromURLResponse>

BlobClient.syncCopyFromURL'denDevralındı

undelete(BlobUndeleteOptions)

Geçici olarak silinen blobun içeriğini ve meta verilerini ve ilişkili geçici olarak silinen anlık görüntüleri geri yükler. Blob'u geri alma işlemi yalnızca 2017-07-29 veya sonraki sürümlerde 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.undelete'denDevralı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.withVersion'danDevralındı