ContainerClient class

ContainerClient, Azure Depolama kapsayıcısının bloblarını işlemenize olanak sağlayan bir URL'yi temsil eder.

Extends

Oluşturucular

ContainerClient(string, PipelineLike)

ContainerClient örneği oluşturur. Bu yöntem, kapsayıcıyı işaret eden bir URL'yi kabul eder. Kodlanmış URL dizesi iki kez kaçılmaz, YALNıZCA URL yolundaki özel karakterlerden kaçılır. Blob adından biri varsa? veya %blob adı URL'de kodlanmalıdır.

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

ContainerClient örneği oluşturur. Bu yöntem, kapsayıcıyı işaret eden bir URL'yi kabul eder. Kodlanmış URL dizesi iki kez kaçılmaz, YALNıZCA URL yolundaki özel karakterlerden kaçılır. Blob adından biri varsa? veya %blob adı URL'de kodlanmalıdır.

ContainerClient(string, string, StoragePipelineOptions)

ContainerClient örneği oluşturur.

Özellikler

accountName
containerName

Kapsayıcının adı.

credential

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

url

Kodlanmış URL dizesi değeri.

Yöntemler

create(ContainerCreateOptions)

Belirtilen hesap altında yeni bir kapsayıcı oluşturur. Aynı ada sahip kapsayıcı zaten varsa, işlem başarısız olur.

createIfNotExists(ContainerCreateOptions)

Belirtilen hesap altında yeni bir kapsayıcı oluşturur. Aynı ada sahip kapsayıcı zaten varsa, değiştirilmez.

delete(ContainerDeleteMethodOptions)

Belirtilen kapsayıcıyı silinmek üzere işaretler. Kapsayıcı ve içindeki tüm bloblar daha sonra çöp toplama sırasında silinir.

deleteBlob(string, ContainerDeleteBlobOptions)

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(ContainerDeleteMethodOptions)

Varsa, belirtilen kapsayıcıyı silinmek üzere işaretler. Kapsayıcı ve içindeki tüm bloblar daha sonra çöp toplama sırasında silinir.

exists(ContainerExistsOptions)

Bu istemci tarafından temsil edilen Azure kapsayıcı kaynağı varsa true döndürür; false olarak ayarlayın. NOT: Mevcut bir kapsayıcı diğer istemciler veya uygulamalar tarafından silinebileceğinden bu işlevi dikkatli kullanın. Aynı ada sahip yeni kapsayıcılar, bu işlev tamamlandıktan sonra diğer istemciler veya uygulamalar tarafından eklenebilir.

generateSasUrl(ContainerGenerateSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle yapılan ContainerClient için kullanılabilir. geçirilen istemci özelliklerine ve parametrelerine göre bir Blob Kapsayıcı Hizmeti Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır.

getAccessPolicy(ContainerGetAccessPolicyOptions)

Belirtilen kapsayıcı için izinleri alır. İzinler, kapsayıcı verilerine genel olarak erişilip erişilemeyeceğini gösterir. UYARI: JavaScript Tarihi, startsOn ve expiresOn dizelerini ayrıştırırken duyarlık kaybına neden olabilir. Örneğin, yeni Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z" değerini alır.

getAppendBlobClient(string)

<xref:AppendBlobClient> oluşturur

getBlobBatchClient()

Toplu işlemleri yürütmek için bir BlobBatchClient nesnesi oluşturur.

getBlobClient(string)

<xref:BlobClient> oluşturur

getBlobLeaseClient(string)

Kapsayıcıdaki kiraları yöneten bir <xref:BlobLeaseClient> alın.

getBlockBlobClient(string)

<xref:BlockBlobClient> oluşturur

getPageBlobClient(string)

<xref:PageBlobClient> oluşturur

getProperties(ContainerGetPropertiesOptions)

Belirtilen kapsayıcı için kullanıcı tanımlı tüm meta verileri ve sistem özelliklerini döndürür. Döndürülen veriler kapsayıcının blob listesini içermez.

listBlobsByHierarchy(string, ContainerListBlobsOptions)

Hiyerarşiye göre tüm blobları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür. öğesini seçin. .byPage(), blobları sayfalardaki hiyerarşiye göre listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

for await söz dizimi kullanan örnek:

for await (const item of containerClient.listBlobsByHierarchy("/")) {
  if (item.kind === "prefix") {
    console.log(`\tBlobPrefix: ${item.name}`);
  } else {
    console.log(`\tBlobItem: name - ${item.name}, last modified - ${item.properties.lastModified}`);
  }
}

iter.next()kullanan örnek:

let iter = containerClient.listBlobsByHierarchy("/", { prefix: "prefix1/" });
let entity = await iter.next();
while (!entity.done) {
  let item = entity.value;
  if (item.kind === "prefix") {
    console.log(`\tBlobPrefix: ${item.name}`);
  } else {
    console.log(`\tBlobItem: name - ${item.name}, last modified - ${item.properties.lastModified}`);
  }
  entity = await iter.next();
}

byPage()kullanan örnek:

console.log("Listing blobs by hierarchy by page");
for await (const response of containerClient.listBlobsByHierarchy("/").byPage()) {
  const segment = response.segment;
  if (segment.blobPrefixes) {
    for (const prefix of segment.blobPrefixes) {
      console.log(`\tBlobPrefix: ${prefix.name}`);
    }
  }
  for (const blob of response.segment.blobItems) {
    console.log(`\tBlobItem: name - ${blob.name}, last modified - ${blob.properties.lastModified}`);
  }
}

Sayfa boyutu üst sınırı olan sayfalama kullanma örneği:

console.log("Listing blobs by hierarchy by page, specifying a prefix and a max page size");

let i = 1;
for await (const response of containerClient.listBlobsByHierarchy("/", { prefix: "prefix2/sub1/"}).byPage({ maxPageSize: 2 })) {
  console.log(`Page ${i++}`);
  const segment = response.segment;

  if (segment.blobPrefixes) {
    for (const prefix of segment.blobPrefixes) {
      console.log(`\tBlobPrefix: ${prefix.name}`);
    }
  }

  for (const blob of response.segment.blobItems) {
    console.log(`\tBlobItem: name - ${blob.name}, last modified - ${blob.properties.lastModified}`);
  }
}
listBlobsFlat(ContainerListBlobsOptions)

Belirtilen hesap altındaki tüm blobları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür. .byPage() sayfalardaki blobları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

for await söz dizimi kullanan örnek:

// Get the containerClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>");`
let i = 1;
for await (const blob of containerClient.listBlobsFlat()) {
  console.log(`Blob ${i++}: ${blob.name}`);
}

iter.next()kullanan örnek:

let i = 1;
let iter = containerClient.listBlobsFlat();
let blobItem = await iter.next();
while (!blobItem.done) {
  console.log(`Blob ${i++}: ${blobItem.value.name}`);
  blobItem = await iter.next();
}

byPage()kullanan örnek:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of containerClient.listBlobsFlat().byPage({ maxPageSize: 20 })) {
  for (const blob of response.segment.blobItems) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}

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

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

// Prints 2 blob names
for (const blob of response.segment.blobItems) {
  console.log(`Blob ${i++}: ${blob.name}`);
}

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

// Passing next marker as continuationToken

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

// Prints 10 blob names
for (const blob of response.segment.blobItems) {
  console.log(`Blob ${i++}: ${blob.name}`);
}
setAccessPolicy(PublicAccessType, SignedIdentifier[], ContainerSetAccessPolicyOptions)

Belirtilen kapsayıcı için izinleri ayarlar. İzinler, bir kapsayıcıdaki bloblara genel olarak erişilip erişilemeyeceğini gösterir. Bir kapsayıcının izinlerini ayarladığınızda, var olan izinler değiştirilir. Erişim veya containerAcl sağlanmadıysa, mevcut kapsayıcı ACL kaldırılır.

Bir kapsayıcıda depolanan erişim ilkesi oluşturduğunuzda, etkili olması 30 saniye kadar sürebilir. Bu aralık boyunca, depolanan erişim ilkesiyle ilişkili paylaşılan erişim imzası, erişim ilkesi etkin olana kadar 403 (Yasak) durum koduyla başarısız olur.

setMetadata(Metadata, ContainerSetMetadataOptions)

Belirtilen kapsayıcı için bir veya daha fazla kullanıcı tanımlı ad-değer çifti ayarlar. Seçenek sağlanmadıysa veya parametrede tanımlı meta veri yoksa kapsayıcı meta verileri kaldırılır.

uploadBlockBlob(string, HttpRequestBody, number, BlockBlobUploadOptions)

Yeni bir blok blobu oluşturur veya mevcut blok blobunun içeriğini güncelleştirir. Mevcut bir blok blobunun güncelleştirilmesi, blob üzerindeki mevcut meta verilerin üzerine yazılır. Kısmi güncelleştirmeler desteklenmez; Mevcut blobun içeriğinin üzerine yeni içerik yazılır. Blok bloblarının kısmi güncelleştirmesini gerçekleştirmek için <xref:BlockBlobClient.stageBlock> ve <xref:BlockBlobClient.commitBlockList>kullanın.

Bu paralel olmayan bir karşıya yükleme yöntemidir; eşzamanlılık yüklemesinde daha iyi performans için lütfen <xref:BlockBlobClient.uploadFile>, <xref:BlockBlobClient.uploadStream> veya <xref:BlockBlobClient.uploadBrowserData> kullanın.

Oluşturucu Ayrıntıları

ContainerClient(string, PipelineLike)

ContainerClient örneği oluşturur. Bu yöntem, kapsayıcıyı işaret eden bir URL'yi kabul eder. Kodlanmış URL dizesi iki kez kaçılmaz, YALNıZCA URL yolundaki özel karakterlerden kaçılır. Blob adından biri varsa? veya %blob adı URL'de kodlanmalıdır.

new ContainerClient(url: string, pipeline: PipelineLike)

Parametreler

url

string

Azure Depolama kapsayıcısına işaret eden "https://myaccount.blob.core.windows.net/mycontainer" gibi bir URL dizesi. AnonymousCredential kullanıyorsanız , "https://myaccount.blob.core.windows.net/mycontainer?sasString" gibi bir SAS ekleyebilirsiniz.

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.

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

ContainerClient örneği oluşturur. Bu yöntem, kapsayıcıyı işaret eden bir URL'yi kabul eder. Kodlanmış URL dizesi iki kez kaçılmaz, YALNıZCA URL yolundaki özel karakterlerden kaçılır. Blob adından biri varsa? veya %blob adı URL'de kodlanmalıdır.

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

Parametreler

url

string

Azure Depolama kapsayıcısına işaret eden "https://myaccount.blob.core.windows.net/mycontainer" gibi bir URL dizesi. AnonymousCredential kullanıyorsanız , "https://myaccount.blob.core.windows.net/mycontainer?sasString" gibi bir SAS ekleyebilirsiniz.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options
StoragePipelineOptions

Opsiyonel. HTTP işlem hattını yapılandırma seçenekleri.

ContainerClient(string, string, StoragePipelineOptions)

ContainerClient örneği oluşturur.

new ContainerClient(connectionString: string, containerName: string, options?: StoragePipelineOptions)

Parametreler

connectionString

string

Bir Azure depolama hesabının hesap bağlantı dizesi veya SAS bağlantı dizesi. [ Not - Hesap bağlantı dizesi yalnızca NODE.JS çalışma zamanında kullanılabilir. ] Hesap bağlantı dizesi örneği - SAS bağlantı dizesi örneği DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

containerName

string

Kapsayıcı adı.

options
StoragePipelineOptions

Opsiyonel. HTTP işlem hattını yapılandırma seçenekleri.

Özellik Ayrıntıları

accountName

accountName: string

Özellik Değeri

string

containerName

Kapsayıcının adı.

string containerName

Özellik Değeri

string

credential

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Özellik Değeri

url

Kodlanmış URL dizesi değeri.

url: string

Özellik Değeri

string

Yöntem Ayrıntıları

create(ContainerCreateOptions)

Belirtilen hesap altında yeni bir kapsayıcı oluşturur. Aynı ada sahip kapsayıcı zaten varsa, işlem başarısız olur.

function create(options?: ContainerCreateOptions)

Parametreler

options
ContainerCreateOptions

Kapsayıcı Oluşturma işlemi seçenekleri.

Örnek kullanım:

const containerClient = blobServiceClient.getContainerClient("<container name>");
const createContainerResponse = await containerClient.create();
console.log("Container was created successfully", createContainerResponse.requestId);

Döndürülenler

createIfNotExists(ContainerCreateOptions)

Belirtilen hesap altında yeni bir kapsayıcı oluşturur. Aynı ada sahip kapsayıcı zaten varsa, değiştirilmez.

function createIfNotExists(options?: ContainerCreateOptions)

Parametreler

Döndürülenler

delete(ContainerDeleteMethodOptions)

Belirtilen kapsayıcıyı silinmek üzere işaretler. Kapsayıcı ve içindeki tüm bloblar daha sonra çöp toplama sırasında silinir.

function delete(options?: ContainerDeleteMethodOptions)

Parametreler

options
ContainerDeleteMethodOptions

Kapsayıcı Silme işlemi seçenekleri.

Döndürülenler

deleteBlob(string, ContainerDeleteBlobOptions)

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 deleteBlob(blobName: string, options?: ContainerDeleteBlobOptions)

Parametreler

blobName

string

options
ContainerDeleteBlobOptions

Blob Silme işlemi seçenekleri.

Döndürülenler

Blob silme yanıt verilerini engelle.

deleteIfExists(ContainerDeleteMethodOptions)

Varsa, belirtilen kapsayıcıyı silinmek üzere işaretler. Kapsayıcı ve içindeki tüm bloblar daha sonra çöp toplama sırasında silinir.

function deleteIfExists(options?: ContainerDeleteMethodOptions)

Parametreler

options
ContainerDeleteMethodOptions

Kapsayıcı Silme işlemi seçenekleri.

Döndürülenler

exists(ContainerExistsOptions)

Bu istemci tarafından temsil edilen Azure kapsayıcı kaynağı varsa true döndürür; false olarak ayarlayın. NOT: Mevcut bir kapsayıcı diğer istemciler veya uygulamalar tarafından silinebileceğinden bu işlevi dikkatli kullanın. Aynı ada sahip yeni kapsayıcılar, bu işlev tamamlandıktan sonra diğer istemciler veya uygulamalar tarafından eklenebilir.

function exists(options?: ContainerExistsOptions)

Parametreler

Döndürülenler

Promise<boolean>

generateSasUrl(ContainerGenerateSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle yapılan ContainerClient için kullanılabilir. geçirilen istemci özelliklerine ve parametrelerine göre bir Blob Kapsayıcı Hizmeti Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır.

function generateSasUrl(options: ContainerGenerateSasUrlOptions)

Parametreler

options
ContainerGenerateSasUrlOptions

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

getAccessPolicy(ContainerGetAccessPolicyOptions)

Belirtilen kapsayıcı için izinleri alır. İzinler, kapsayıcı verilerine genel olarak erişilip erişilemeyeceğini gösterir. UYARI: JavaScript Tarihi, startsOn ve expiresOn dizelerini ayrıştırırken duyarlık kaybına neden olabilir. Örneğin, yeni Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z" değerini alır.

function getAccessPolicy(options?: ContainerGetAccessPolicyOptions)

Parametreler

options
ContainerGetAccessPolicyOptions

Kapsayıcı Erişim İlkesi alma işlemi seçenekleri.

Döndürülenler

getAppendBlobClient(string)

<xref:AppendBlobClient> oluşturur

function getAppendBlobClient(blobName: string)

Parametreler

blobName

string

Ekleme blobu adı

Döndürülenler

getBlobBatchClient()

Toplu işlemleri yürütmek için bir BlobBatchClient nesnesi oluşturur.

function getBlobBatchClient()

Döndürülenler

Bu kapsayıcı için yeni bir BlobBatchClient nesnesi.

getBlobClient(string)

<xref:BlobClient> oluşturur

function getBlobClient(blobName: string)

Parametreler

blobName

string

Blob adı

Döndürülenler

Verilen blob adı için yeni bir BlobClient nesnesi.

getBlobLeaseClient(string)

Kapsayıcıdaki kiraları yöneten bir <xref:BlobLeaseClient> alın.

function getBlobLeaseClient(proposeLeaseId?: string)

Parametreler

proposeLeaseId

string

İlk önerilen kira kimliği.

Döndürülenler

Kapsayıcıdaki kiraları yönetmek için yeni bir BlobLeaseClient nesnesi.

getBlockBlobClient(string)

<xref:BlockBlobClient> oluşturur

function getBlockBlobClient(blobName: string)

Parametreler

blobName

string

Blok blobu adı

Örnek kullanım:

const content = "Hello world!";

const blockBlobClient = containerClient.getBlockBlobClient("<blob name>");
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);

Döndürülenler

getPageBlobClient(string)

<xref:PageBlobClient> oluşturur

function getPageBlobClient(blobName: string)

Parametreler

blobName

string

Sayfa blobu adı

Döndürülenler

getProperties(ContainerGetPropertiesOptions)

Belirtilen kapsayıcı için kullanıcı tanımlı tüm meta verileri ve sistem özelliklerini döndürür. Döndürülen veriler kapsayıcının blob listesini içermez.

function getProperties(options?: ContainerGetPropertiesOptions)

Parametreler

options
ContainerGetPropertiesOptions

Kapsayıcı Alma Özellikleri işlemine yönelik seçenekler.

Döndürülenler

listBlobsByHierarchy(string, ContainerListBlobsOptions)

Hiyerarşiye göre tüm blobları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür. öğesini seçin. .byPage(), blobları sayfalardaki hiyerarşiye göre listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

for await söz dizimi kullanan örnek:

for await (const item of containerClient.listBlobsByHierarchy("/")) {
  if (item.kind === "prefix") {
    console.log(`\tBlobPrefix: ${item.name}`);
  } else {
    console.log(`\tBlobItem: name - ${item.name}, last modified - ${item.properties.lastModified}`);
  }
}

iter.next()kullanan örnek:

let iter = containerClient.listBlobsByHierarchy("/", { prefix: "prefix1/" });
let entity = await iter.next();
while (!entity.done) {
  let item = entity.value;
  if (item.kind === "prefix") {
    console.log(`\tBlobPrefix: ${item.name}`);
  } else {
    console.log(`\tBlobItem: name - ${item.name}, last modified - ${item.properties.lastModified}`);
  }
  entity = await iter.next();
}

byPage()kullanan örnek:

console.log("Listing blobs by hierarchy by page");
for await (const response of containerClient.listBlobsByHierarchy("/").byPage()) {
  const segment = response.segment;
  if (segment.blobPrefixes) {
    for (const prefix of segment.blobPrefixes) {
      console.log(`\tBlobPrefix: ${prefix.name}`);
    }
  }
  for (const blob of response.segment.blobItems) {
    console.log(`\tBlobItem: name - ${blob.name}, last modified - ${blob.properties.lastModified}`);
  }
}

Sayfa boyutu üst sınırı olan sayfalama kullanma örneği:

console.log("Listing blobs by hierarchy by page, specifying a prefix and a max page size");

let i = 1;
for await (const response of containerClient.listBlobsByHierarchy("/", { prefix: "prefix2/sub1/"}).byPage({ maxPageSize: 2 })) {
  console.log(`Page ${i++}`);
  const segment = response.segment;

  if (segment.blobPrefixes) {
    for (const prefix of segment.blobPrefixes) {
      console.log(`\tBlobPrefix: ${prefix.name}`);
    }
  }

  for (const blob of response.segment.blobItems) {
    console.log(`\tBlobItem: name - ${blob.name}, last modified - ${blob.properties.lastModified}`);
  }
}
function listBlobsByHierarchy(delimiter: string, options?: ContainerListBlobsOptions)

Parametreler

delimiter

string

Sanal hiyerarşiyi tanımlamak için kullanılan karakter veya dize

options
ContainerListBlobsOptions

Blobları listeleme işlemi seçenekleri.

Döndürülenler

PagedAsyncIterableIterator<Object & BlobPrefix | Object & BlobItem, ContainerListBlobHierarchySegmentResponse>

listBlobsFlat(ContainerListBlobsOptions)

Belirtilen hesap altındaki tüm blobları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür. .byPage() sayfalardaki blobları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

for await söz dizimi kullanan örnek:

// Get the containerClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>");`
let i = 1;
for await (const blob of containerClient.listBlobsFlat()) {
  console.log(`Blob ${i++}: ${blob.name}`);
}

iter.next()kullanan örnek:

let i = 1;
let iter = containerClient.listBlobsFlat();
let blobItem = await iter.next();
while (!blobItem.done) {
  console.log(`Blob ${i++}: ${blobItem.value.name}`);
  blobItem = await iter.next();
}

byPage()kullanan örnek:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of containerClient.listBlobsFlat().byPage({ maxPageSize: 20 })) {
  for (const blob of response.segment.blobItems) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}

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

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

// Prints 2 blob names
for (const blob of response.segment.blobItems) {
  console.log(`Blob ${i++}: ${blob.name}`);
}

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

// Passing next marker as continuationToken

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

// Prints 10 blob names
for (const blob of response.segment.blobItems) {
  console.log(`Blob ${i++}: ${blob.name}`);
}
function listBlobsFlat(options?: ContainerListBlobsOptions)

Parametreler

options
ContainerListBlobsOptions

Blobları listeleme seçenekleri.

Döndürülenler

PagedAsyncIterableIterator<BlobItem, ContainerListBlobFlatSegmentResponse>

Disk belleğini destekleyen asyncIterableIterator.

setAccessPolicy(PublicAccessType, SignedIdentifier[], ContainerSetAccessPolicyOptions)

Belirtilen kapsayıcı için izinleri ayarlar. İzinler, bir kapsayıcıdaki bloblara genel olarak erişilip erişilemeyeceğini gösterir. Bir kapsayıcının izinlerini ayarladığınızda, var olan izinler değiştirilir. Erişim veya containerAcl sağlanmadıysa, mevcut kapsayıcı ACL kaldırılır.

Bir kapsayıcıda depolanan erişim ilkesi oluşturduğunuzda, etkili olması 30 saniye kadar sürebilir. Bu aralık boyunca, depolanan erişim ilkesiyle ilişkili paylaşılan erişim imzası, erişim ilkesi etkin olana kadar 403 (Yasak) durum koduyla başarısız olur.

function setAccessPolicy(access?: PublicAccessType, containerAcl?: SignedIdentifier[], options?: ContainerSetAccessPolicyOptions)

Parametreler

access
PublicAccessType

Kapsayıcıdaki verilere genel erişim düzeyi.

containerAcl

SignedIdentifier[]

Her biri benzersiz bir kimliğe ve erişim ilkesinin ayrıntılarına sahip öğe dizisi.

options
ContainerSetAccessPolicyOptions

Kapsayıcı Kümesi Erişim İlkesi işlemi seçenekleri.

Döndürülenler

setMetadata(Metadata, ContainerSetMetadataOptions)

Belirtilen kapsayıcı için bir veya daha fazla kullanıcı tanımlı ad-değer çifti ayarlar. Seçenek sağlanmadıysa veya parametrede tanımlı meta veri yoksa kapsayıcı meta verileri kaldırılır.

function setMetadata(metadata?: Metadata, options?: ContainerSetMetadataOptions)

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
ContainerSetMetadataOptions

Kapsayıcı Kümesi Meta Verileri işlemi seçenekleri.

Döndürülenler

uploadBlockBlob(string, HttpRequestBody, number, BlockBlobUploadOptions)

Yeni bir blok blobu oluşturur veya mevcut blok blobunun içeriğini güncelleştirir. Mevcut bir blok blobunun güncelleştirilmesi, blob üzerindeki mevcut meta verilerin üzerine yazılır. Kısmi güncelleştirmeler desteklenmez; Mevcut blobun içeriğinin üzerine yeni içerik yazılır. Blok bloblarının kısmi güncelleştirmesini gerçekleştirmek için <xref:BlockBlobClient.stageBlock> ve <xref:BlockBlobClient.commitBlockList>kullanın.

Bu paralel olmayan bir karşıya yükleme yöntemidir; eşzamanlılık yüklemesinde daha iyi performans için lütfen <xref:BlockBlobClient.uploadFile>, <xref:BlockBlobClient.uploadStream> veya <xref:BlockBlobClient.uploadBrowserData> kullanın.

function uploadBlockBlob(blobName: string, body: HttpRequestBody, contentLength: number, options?: BlockBlobUploadOptions)

Parametreler

blobName

string

Oluşturulacak veya güncelleştirilecek blok blobunun adı.

body

HttpRequestBody

Blob, dize, ArrayBuffer, ArrayBufferView veya uzaklığı veri kaynağından başlayan yeni bir Okunabilir akış döndüren bir işlev.

contentLength

number

Bayt cinsinden gövde uzunluğu. Base64/Onaltılık kodlanmamış karakterler de dahil olmak üzere bir dizenin gövde uzunluğunu hesaplamak için Buffer.byteLength() kullanın.

options
BlockBlobUploadOptions

Blok Blobu Karşıya Yükleme işlemini yapılandırma seçenekleri.

Döndürülenler

Promise<Object>

Blok Blobu karşıya yükleme yanıt verileri ve karşılık gelen BlockBlobClient örneği.