AppendBlobClient class
AppendBlobClient, ekleme blobları için geçerli olan bir dizi işlemi tanımlar.
- Extends
Oluşturucular
Append |
AppendBlobClient örneğini oluşturur. Bu yöntem, bir ekleme blob'una 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 karakterler kaçış olarak kullanılır. Blob adında ? varsa veya %, blob adı URL'de kodlanmalıdır. |
Append |
AppendBlobClient örneğini oluşturur. Bu yöntem, bir ekleme blob'una 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 karakterler kaçış olarak kullanılır. Blob adında ? varsa veya %, blob adı URL'de kodlanmalıdır. |
Append |
AppendBlobClient örneğini oluşturur. |
Özellikler
container |
Blobun ilişkili olduğu depolama kapsayıcısının adı. |
name | Blobun adı. |
Devralınan Özellikler
account |
|
credential | AnonymousCredential, StorageSharedKeyCredential veya hizmete yönelik isteklerin |
url | Kodlanmış URL dizesi değeri. |
Yöntemler
append |
Mevcut ekleme blobunun sonuna yeni bir veri bloğu işler. Bkz. https://docs.microsoft.com/rest/api/storageservices/append-block |
append |
Ekleme Bloğu işlemi, içeriklerinin kaynak URL'den okunduğu mevcut ekleme blobunun sonuna yeni bir veri bloğu işler. Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/append-block-from-url |
create(Append |
0 uzunluklu bir ekleme blobu oluşturur. Ekleme blobuna veri eklemek için AppendBlock'u çağır. Bkz. https://docs.microsoft.com/rest/api/storageservices/put-blob |
create |
0 uzunluklu bir ekleme blobu oluşturur. Ekleme blobuna veri eklemek için AppendBlock'u çağır. 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 |
seal(Append |
Ekleme blobunu mühürler ve salt okunur hale getirir. |
with |
Kaynakla aynı ancak belirtilen anlık görüntü zaman damgasıyla yeni bir AppendBlobClient 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
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. Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob |
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'ı arayarak 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 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:
El ile yoklama kullanma örneği:
İlerleme güncelleştirmelerini kullanma örneği:
Değişen yoklama aralığının kullanıldığı örnek (varsayılan 15 saniye):
Kopyalama iptali örneği:
|
create |
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(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. Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob |
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. Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob |
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.
Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob |
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 downloadToFile'ı göz önünde bulundurun. |
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 downloadToFile'ı göz önünde bulundurun. |
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. 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(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 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 |
get |
AppendBlobClient nesnesi oluşturur. |
get |
Blob üzerindeki kiraları yöneten bir BlobLeaseClient alın. |
get |
BlockBlobClient nesnesi oluşturur. |
get |
PageBlobClient nesnesi oluşturur. |
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. Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties UYARI: Yanıtta |
get |
Temel alınan blobla ilişkili etiketleri alır. |
set |
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 |
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. Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties |
set |
Blob üzerinde değişmezlik ilkesini ayarlayın. |
set |
Blob üzerinde yasal saklama ayarlayın. |
set |
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 |
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. |
sync |
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(Blob |
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 |
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ı
AppendBlobClient(string, PipelineLike)
AppendBlobClient örneğini oluşturur. Bu yöntem, bir ekleme blob'una 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 karakterler kaçış olarak kullanılır. Blob adında ? varsa veya %, blob adı URL'de kodlanmalıdır.
new AppendBlobClient(url: string, pipeline: PipelineLike)
Parametreler
- url
-
string
Azure Depolama ekleme blobu'na işaret eden "https://myaccount.blob.core.windows.net/mycontainer/appendblob" gibi bir URL dizesi. AnonymousCredential kullanıyorsanız bir SAS ekleyebilirsiniz; örneğin, "https://myaccount.blob.core.windows.net/mycontainer/appendblob?sasString". 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 karakterler kaçış olarak 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".
- pipeline
- PipelineLike
Varsayılan işlem hattı oluşturmak veya özelleştirilmiş bir işlem hattı sağlamak için newPipeline() öğesini çağırabilirsiniz.
AppendBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
AppendBlobClient örneğini oluşturur. Bu yöntem, bir ekleme blob'una 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 karakterler kaçış olarak kullanılır. Blob adında ? varsa veya %, blob adı URL'de kodlanmalıdır.
new AppendBlobClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parametreler
- url
-
string
Azure Depolama ekleme blobu'na işaret eden "https://myaccount.blob.core.windows.net/mycontainer/appendblob" gibi bir URL dizesi. AnonymousCredential kullanıyorsanız bir SAS ekleyebilirsiniz; örneğin, "https://myaccount.blob.core.windows.net/mycontainer/appendblob?sasString". 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 karakterler kaçış olarak 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".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
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.
- options
- StoragePipelineOptions
İsteğe bağlı. HTTP işlem hattını yapılandırma seçenekleri.
AppendBlobClient(string, string, string, StoragePipelineOptions)
AppendBlobClient örneğini oluşturur.
new AppendBlobClient(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
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
BlobClient.credential'danDevralındı
url
Yöntem Ayrıntıları
appendBlock(RequestBodyType, number, AppendBlobAppendBlockOptions)
Mevcut ekleme blobunun sonuna yeni bir veri bloğu işler.
Bkz. https://docs.microsoft.com/rest/api/storageservices/append-block
function appendBlock(body: RequestBodyType, contentLength: number, options?: AppendBlobAppendBlockOptions): Promise<AppendBlobAppendBlockResponse>
Parametreler
- body
- HttpRequestBody
Eklenecek veriler.
- contentLength
-
number
Gövdenin bayt cinsinden uzunluğu.
- options
- AppendBlobAppendBlockOptions
Ekleme Bloğu işleminin seçenekleri.
Örnek kullanım:
const content = "Hello World!";
// Create a new append blob and append data to the blob.
const newAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await newAppendBlobClient.create();
await newAppendBlobClient.appendBlock(content, content.length);
// Append data to an existing append blob.
const existingAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await existingAppendBlobClient.appendBlock(content, content.length);
Döndürülenler
Promise<AppendBlobAppendBlockResponse>
appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)
Ekleme Bloğu işlemi, içeriklerinin kaynak URL'den okunduğu mevcut ekleme blobunun sonuna yeni bir veri bloğu işler.
Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/append-block-from-url
function appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions): Promise<AppendBlobAppendBlockFromUrlResponse>
Parametreler
- sourceURL
-
string
Kopyanın kaynağı olacak blobun URL'si. Aynı depolama hesabındaki bir kaynak blob, Paylaşılan Anahtar aracılığıyla doğrulanabilir. Ancak, kaynak başka bir hesaptaki bir blobsa, kaynak blob ortak olmalıdır veya paylaşılan erişim imzası aracılığıyla kimlik doğrulaması yapılmalıdır. Kaynak blob genel ise, işlemi gerçekleştirmek için kimlik doğrulaması gerekmez.
- sourceOffset
-
number
Eklenecek kaynakta uzaklık
- count
-
number
Blok olarak eklenecek bayt sayısı
Döndürülenler
Promise<AppendBlobAppendBlockFromUrlResponse>
create(AppendBlobCreateOptions)
0 uzunluklu bir ekleme blobu oluşturur. Ekleme blobuna veri eklemek için AppendBlock'u çağır.
Bkz. https://docs.microsoft.com/rest/api/storageservices/put-blob
function create(options?: AppendBlobCreateOptions): Promise<AppendBlobCreateResponse>
Parametreler
- options
- AppendBlobCreateOptions
Ekleme Bloğu Oluşturma işleminin seçenekleri.
Örnek kullanım:
const appendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await appendBlobClient.create();
Döndürülenler
Promise<AppendBlobCreateResponse>
createIfNotExists(AppendBlobCreateIfNotExistsOptions)
0 uzunluklu bir ekleme blobu oluşturur. Ekleme blobuna veri eklemek için AppendBlock'u çağır. 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(options?: AppendBlobCreateIfNotExistsOptions): Promise<AppendBlobCreateIfNotExistsResponse>
Parametreler
Döndürülenler
Promise<AppendBlobCreateIfNotExistsResponse>
seal(AppendBlobSealOptions)
Ekleme blobunu mühürler ve salt okunur hale getirir.
function seal(options?: AppendBlobSealOptions): Promise<AppendBlobAppendBlockResponse>
Parametreler
- options
- AppendBlobSealOptions
Döndürülenler
Promise<AppendBlobAppendBlockResponse>
withSnapshot(string)
Kaynakla aynı ancak belirtilen anlık görüntü zaman damgasıyla yeni bir AppendBlobClient 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): AppendBlobClient
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 AppendBlobClient 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
Blob Durdurma URL'sinden Kopyalama işleminin isteğe bağlı seçenekleri.
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'ı arayarak 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 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 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
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>
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'si.
BlobClient.generateSasUrl'danDevralındı
getAppendBlobClient()
AppendBlobClient nesnesi oluşturur.
function getAppendBlobClient(): AppendBlobClient
Döndürülenler
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
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
BlobClient.getBlockBlobClient'danDevralındı
getPageBlobClient()
PageBlobClient nesnesi oluşturur.
function getPageBlobClient(): PageBlobClient
Döndürülenler
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
Bu blobun sürümüne işaret eden yeni bir BlobClient nesnesi.
BlobClient.withVersion'danDevralındı