PageBlobClient class
PageBlobClient, sayfa blobları için geçerli olan bir dizi işlemi tanımlar.
- Extends
Oluşturucular
Page |
PageBlobClient örneğini oluşturur. |
Page |
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. |
Page |
PageBlobClient örneğini oluşturur. |
Özellikler
account |
|
container |
Blobun ilişkili olduğu depolama kapsayıcısının adı. |
credential | AnonymousCredential, StorageSharedKeyCredential veya hizmete yönelik isteklerin |
name | Blobun adı. |
url | Kodlanmış URL dizesi değeri. |
Yöntemler
abort |
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. |
begin |
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 |
clear |
Belirtilen sayfaları sayfa blobundan serbest kaldırır. |
create(number, Page |
Belirtilen uzunlukta bir sayfa blobu oluşturur. Veri verilerini sayfa blobuna yüklemek için uploadPages çağrısında bulunur. |
create |
Belirtilen uzunlukta bir sayfa blobu oluşturur. Veri verilerini sayfa blobuna 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. |
create |
Blobun salt okunur anlık görüntüsünü oluşturur. |
delete(Blob |
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. |
delete |
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. |
delete |
Blob üzerindeki değişmezlik ilkesini silin. |
download(number, number, Blob |
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.
|
download |
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 göz önünde bulundurun <xref:downloadToFile>. |
download |
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 büyük bloblar için göz önünde bulundurun <xref:downloadToFile>. |
download |
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. Uzaklık ve sayı isteğe bağlıdır, blob'un tamamını indirmek için sırasıyla 0 ve tanımsız değerini geçirir. |
exists(Blob |
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. |
generate |
Yalnızca paylaşılan anahtar kimlik bilgileriyle inşa edilen 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. |
get |
AppendBlobClient nesnesi oluşturur. |
get |
Blobdaki kiraları yöneten bir <xref:BlobLeaseClient> alma. |
get |
BlockBlobClient nesnesi oluşturur. |
get |
PageBlobClient nesnesi oluşturur. |
get |
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. |
get |
Belirtilen anlık görüntü ile bu sayfa blobu arasında farklılık gösteren sayfa aralıkları koleksiyonunu alır. |
get |
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. |
get |
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. |
get |
Temel alınan blobla ilişkili etiketleri alır. |
resize(number, Page |
Sayfa blobunu belirtilen boyuta (512'nin katı olmalıdır) yeniden boyutlandırıyor. |
set |
Katmanı bir blob üzerinde ayarlar. bu iş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/Seyrek Erişimli/Arşiv depolama türünü belirler. Bu işlem blob'un ETag'ini güncelleştirmez. |
set |
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. |
set |
Blobda değişmezlik ilkesi ayarlayın. |
set |
Blob üzerinde yasal saklamayı ayarlayın. |
set |
Belirtilen blob için kullanıcı tanımlı meta verileri bir veya daha fazla ad-değer çifti olarak ayarlar. Hiçbir seçenek sağlanmadıysa veya parametrede tanımlı meta veri yoksa blob meta verileri kaldırılır. |
set |
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. |
start |
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. |
sync |
Zaman uyumlu URL'den Kopyala işlemi bir blobu veya İnternet kaynağını yeni bir bloba kopyalar. Kopyalama tamamlanana kadar yanıt döndürmez. |
undelete(Blob |
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 özelliği yalnızca 2017-07-29 veya sonraki sürümlerde desteklenir. |
update |
Sayfa blob'larının sıra numarasını ayarlar. |
upload |
Sayfa blob'una 1 veya daha fazla sayfa yazar. Başlangıç ve bitiş uzaklıkları 512'nin katı olmalıdır. |
upload |
Sayfaları Karşıya Yükle işlemi, içeriklerin URL'den okunduğu sayfa blob'una bir sayfa aralığı yazar. |
with |
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. |
with |
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 İstemci dizesi. AnonymousCredential kullanıyorsanız SAS ekleyebilirsiniz; örneğin, "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString".
- 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ı
accountName
accountName: string
Özellik Değeri
string
containerName
Blobun ilişkili olduğu depolama kapsayıcısının adı.
string containerName
Özellik Değeri
string
credential
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.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Özellik Değeri
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
name
Blobun adı.
string name
Özellik Değeri
string
url
Kodlanmış URL dizesi değeri.
url: string
Özellik Değeri
string
Yöntem 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.
function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions)
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>
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.
function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions)
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<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>
clearPages(number, number, PageBlobClearPagesOptions)
Belirtilen sayfaları sayfa blobundan serbest kaldırır.
function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions)
Parametreler
- offset
-
number
Temizlenmiş sayfaların 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 sayfa blobuna yüklemek için uploadPages çağrısında bulunur.
function create(size: number, options?: PageBlobCreateOptions)
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 sayfa blobuna 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.
function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions)
Parametreler
- size
-
number
sayfa blobunun boyutu.
- options
- PageBlobCreateIfNotExistsOptions
Döndürülenler
Promise<PageBlobCreateIfNotExistsResponse>
createSnapshot(BlobCreateSnapshotOptions)
Blobun salt okunur anlık görüntüsünü oluşturur.
function createSnapshot(options?: BlobCreateSnapshotOptions)
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>
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.
function delete(options?: BlobDeleteOptions)
Parametreler
- options
- BlobDeleteOptions
Blob Silme işlemi için isteğe bağlı seçenekler.
Döndürülenler
Promise<BlobDeleteResponse>
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.
function deleteIfExists(options?: BlobDeleteOptions)
Parametreler
- options
- BlobDeleteOptions
Blob Silme işlemi için isteğe bağlı seçenekler.
Döndürülenler
Promise<BlobDeleteIfExistsResponse>
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)
Blob üzerindeki değişmezlik ilkesini silin.
function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)
Parametreler
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 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
function download(offset?: number, count?: number, options?: BlobDownloadOptions)
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>
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 göz önünde bulundurun <xref:downloadToFile>.
function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions)
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>
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 büyük bloblar için göz önünde bulundurun <xref:downloadToFile>.
function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions)
Parametreler
- offset
-
number
Blok blobunun indirilmesi gereken konumdan (bayt cinsinden)
- count
-
number
Ne kadar verinin (bayt cinsinden) indirileceği. 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ını 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 tanımsız değerini geçirir.
function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions)
Parametreler
- filePath
-
string
- offset
-
number
Blok blobunun indirilmesi gereken konumdan.
- count
-
number
ne kadar veri indirileceği. Undefined geçirirken sonuna 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)
Parametreler
- options
- BlobExistsOptions
mevcut işlem seçeneklerine tıklayın.
Döndürülenler
Promise<boolean>
generateSasUrl(BlobGenerateSasUrlOptions)
Yalnızca paylaşılan anahtar kimlik bilgileriyle inşa edilen 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.
function generateSasUrl(options: BlobGenerateSasUrlOptions)
Parametreler
- options
- BlobGenerateSasUrlOptions
İsteğe bağlı parametreler.
Döndürülenler
Promise<string>
Bu istemci tarafından temsil edilen kaynağın URI'sini içeren SAS URI'sini ve ardından oluşturulan SAS belirtecini izler.
getAppendBlobClient()
getBlobLeaseClient(string)
Blobdaki kiraları yöneten bir <xref:BlobLeaseClient> alma.
function getBlobLeaseClient(proposeLeaseId?: string)
Parametreler
- proposeLeaseId
-
string
İlk önerilen kira kimliği.
Döndürülenler
Blob üzerindeki kiraları yönetmek için yeni bir BlobLeaseClient nesnesi.
getBlockBlobClient()
getPageBlobClient()
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.
function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions)
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.
function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions)
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.
function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions)
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.
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.
function getProperties(options?: BlobGetPropertiesOptions)
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)
Parametreler
- options
- BlobGetTagsOptions
Döndürülenler
Promise<BlobGetTagsResponse>
resize(number, PageBlobResizeOptions)
Sayfa blobunu belirtilen boyuta (512'nin katı olmalıdır) yeniden boyutlandırıyor.
function resize(size: number, options?: PageBlobResizeOptions)
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.
setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)
Katmanı bir blob üzerinde ayarlar. bu iş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/Seyrek Erişimli/Arşiv depolama türünü belirler. Bu işlem blob'un ETag'ini güncelleştirmez.
function setAccessTier(tier: BlockBlobTier | PremiumPageBlobTier | string, options?: BlobSetTierOptions)
Parametreler
- tier
-
BlockBlobTier | PremiumPageBlobTier | 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>
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.
function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions)
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, tarayıcının dosya türüne göre işlevsellik sağlamasıdır blobContentType
.
- options
- BlobSetHTTPHeadersOptions
Blob Kümesi HTTP Üst Bilgileri işlemi için isteğe bağlı seçenekler.
Döndürülenler
Promise<BlobSetHTTPHeadersResponse>
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)
Blobda değişmezlik ilkesi ayarlayın.
function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions)
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>
setLegalHold(boolean, BlobSetLegalHoldOptions)
Blob üzerinde yasal saklamayı ayarlayın.
function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions)
Parametreler
- legalHoldEnabled
-
boolean
- options
- BlobSetLegalHoldOptions
Blob üzerinde yasal tutma 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. Hiçbir seçenek sağlanmadıysa veya parametrede tanımlı meta veri yoksa blob meta verileri kaldırılır.
function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions)
Parametreler
- metadata
- Metadata
Mevcut 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şleminin isteğe bağlı seçenekleri.
Döndürülenler
Promise<BlobSetMetadataResponse>
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)
Parametreler
- tags
- Tags
- options
- BlobSetTagsOptions
Döndürülenler
Promise<BlobSetTagsResponse>
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.
function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions)
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=
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.
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)
Zaman uyumlu URL'den Kopyala işlemi bir blobu veya İnternet kaynağını yeni bir bloba kopyalar. Kopyalama tamamlanana kadar yanıt döndürmez.
function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions)
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>
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 özelliği yalnızca 2017-07-29 veya sonraki sürümlerde desteklenir.
function undelete(options?: BlobUndeleteOptions)
Parametreler
- options
- BlobUndeleteOptions
Blob Silme işleminin isteğe bağlı seçenekleri.
Döndürülenler
Promise<BlobUndeleteResponse>
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)
Sayfa blob'larının sıra numarasını ayarlar.
function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions)
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
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.
function uploadPages(body: HttpRequestBody, offset: number, count: number, options?: PageBlobUploadPagesOptions)
Parametreler
- body
-
HttpRequestBody
Karşıya yüklenecek veriler
- offset
-
number
Hedef sayfa blobunun uzaklığı
- count
-
number
Gövdenin içerik uzunluğu ve 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çeriklerin URL'den okunduğu sayfa blob'una bir sayfa aralığı yazar.
function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions)
Parametreler
- sourceURL
-
string
Kopyalama kaynağının URL'sini belirtin; Kimlik doğrulaması için Paylaşılan Erişim İmzası (SAS) gerekebilir
- sourceOffset
-
number
Kopyalanacak kaynak uzaklığı. Kaynak sayfa blobunun başından kopyalanacak 0 değerini geçirme
- destOffset
-
number
Hedef sayfa blobunun uzaklığı
- count
-
number
Kaynak sayfa blobundan karşıya yüklenecek bayt sayısı
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)
Parametreler
- snapshot
-
string
Anlık görüntü zaman damgası.
Döndürülenler
Kaynakla aynı ancak belirtilen anlık görüntü zaman damgasına sahip yeni bir PageBlobClient 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)
Parametreler
- versionId
-
string
versionId.
Döndürülenler
Bu blobun sürümüne işaret eden yeni bir BlobClient nesnesi.
Azure SDK for JavaScript