BlobClient class

Başvuru

Paket:: @azure/storage-blob

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

Extends: StorageClient

Oluşturucular

BlobClient(string, PipelineLike)	BlobClient örneğini oluşturur. Bu yöntem, bir bloba işaret eden kodlanmış bir URL'yi veya kodlanmamış URL'yi kabul eder. Kodlanmış URL dizesi iki kez kaçılmaz, YALNıZCA URL yolundaki özel karakterler kaçış olarak kullanılır. Blob adında ? varsa veya %, blob adı URL'de kodlanmalıdır.
BlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	BlobClient örneğini oluşturur. Bu yöntem, bir bloba işaret eden kodlanmış bir URL'yi veya kodlanmamış URL'yi kabul eder. Kodlanmış URL dizesi iki kez kaçılmaz, YALNıZCA URL yolundaki özel karakterler kaçış olarak kullanılır. Blob adında ? varsa veya %, blob adı URL'de kodlanmalıdır.
BlobClient(string, string, string, StoragePipelineOptions)	Bağlantı dizesinden bir BlobClient örneği oluşturur.

Özellikler

accountName
containerName	Blobun ilişkili olduğu depolama kapsayıcısının adı.
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.
name	Blobun adı.
url	Kodlanmış URL dizesi değeri.

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.
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.
createSnapshot(BlobCreateSnapshotOptions)	Blobun salt okunur anlık görüntüsünü oluşturur.
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.
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.
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
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>.
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 göz önünde bulundurun <xref:downloadToFile>.
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.
getAppendBlobClient()	AppendBlobClient nesnesi oluşturur.
getBlobLeaseClient(string)	Blob üzerindeki kiraları yöneten bir <xref: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.
getTags(BlobGetTagsOptions)	Temel alınan blobla ilişkili etiketleri alır.
setAccessTier(BlockBlobTier \| PremiumPageBlobTier \| 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/Seyrek Erişimli/Arşiv depolama türünü belirler. Bu işlem blob'un ETag'ini güncelleştirmez.
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.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Blobda değişmezlik ilkesi ayarlayın.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Blob üzerinde yasal saklamayı 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. Hiçbir seçenek sağlanmadıysa veya parametrede tanımlı meta veri yoksa blob meta verileri kaldırılır.
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. Kopyalama tamamlanana kadar yanıt döndürmez.
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.
withSnapshot(string)	Kaynakla aynı ancak belirtilen anlık görüntü zaman damgasıyla yeni bir BlobClient nesnesi oluşturur. "" değerini sağlayın, anlık görüntüyü kaldırır ve temel bloba bir İstemci döndürür.
withVersion(string)	Bu blobun bir sürümünü işaret eden yeni bir BlobClient nesnesi oluşturur. "" değerini sağlayın, versionId değerini kaldırır ve temel bloba bir İstemci döndürür.

Oluşturucu Ayrıntıları

BlobClient(string, PipelineLike)

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

new BlobClient(url: string, pipeline: PipelineLike)

Parametreler

url: string

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

pipeline: PipelineLike

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

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

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

Parametreler

url: string

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.

BlobClient(string, string, string, StoragePipelineOptions)

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

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

Parametreler

connectionString: string

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

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

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

options: BlobDeleteImmutabilityPolicyOptions

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

Döndürülenler

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

Meta verileri ve özellikleri dahil olmak üzere bir blobu 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.

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çirilirken 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. 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)

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.

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

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 ve ardından oluşturulan SAS belirtecini içeren SAS URI'sini.

getAppendBlobClient()

AppendBlobClient nesnesi oluşturur.

function getAppendBlobClient()

Döndürülenler

AppendBlobClient

getBlobLeaseClient(string)

Blob üzerindeki kiraları yöneten bir <xref:BlobLeaseClient> alın.

function getBlobLeaseClient(proposeLeaseId?: string)

Parametreler

proposeLeaseId: string

İlk önerilen kira kimliği.

Döndürülenler

BlobLeaseClient

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

getBlockBlobClient()

BlockBlobClient nesnesi oluşturur.

function getBlockBlobClient()

Döndürülenler

BlockBlobClient

getPageBlobClient()

PageBlobClient nesnesi oluşturur.

function getPageBlobClient()

Döndürülenler

PageBlobClient

getProperties(BlobGetPropertiesOptions)

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

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>

setAccessTier(BlockBlobTier | PremiumPageBlobTier | 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/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>

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>

withSnapshot(string)

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

function withSnapshot(snapshot: string)

Parametreler

snapshot: string

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

Döndürülenler

BlobClient

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

withVersion(string)

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

function withVersion(versionId: string)

Parametreler

versionId: string

versionId.

Döndürülenler

BlobClient

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

Aracılığıyla paylaş

BlobClient class

Oluşturucular

Özellikler

Yöntemler

Oluşturucu Ayrıntıları

BlobClient(string, PipelineLike)

Parametreler

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

Parametreler

BlobClient(string, string, string, StoragePipelineOptions)

Parametreler

Özellik Ayrıntıları

accountName

Özellik Değeri

containerName

Özellik Değeri

credential

Özellik Değeri

name

Özellik Değeri

url

Özellik Değeri

Yöntem Ayrıntıları

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Parametreler

Döndürülenler

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Parametreler

Döndürülenler

createSnapshot(BlobCreateSnapshotOptions)

Parametreler

Döndürülenler

delete(BlobDeleteOptions)

Parametreler

Döndürülenler

deleteIfExists(BlobDeleteOptions)

Parametreler

Döndürülenler

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Parametreler

Döndürülenler

download(number, number, BlobDownloadOptions)

Parametreler

Döndürülenler

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

Parametreler

Döndürülenler

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

Parametreler

Döndürülenler

downloadToFile(string, number, number, BlobDownloadOptions)

Parametreler

Döndürülenler

exists(BlobExistsOptions)

Parametreler

Döndürülenler

generateSasUrl(BlobGenerateSasUrlOptions)

Parametreler

Döndürülenler

getAppendBlobClient()

Döndürülenler

getBlobLeaseClient(string)

Parametreler

Döndürülenler

getBlockBlobClient()

Döndürülenler

getPageBlobClient()

Döndürülenler

getProperties(BlobGetPropertiesOptions)

Parametreler

Döndürülenler

getTags(BlobGetTagsOptions)

Parametreler

Döndürülenler

setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)

Parametreler

Döndürülenler

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Parametreler