ContainerClient class

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

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

Extends

StorageClient

Oluşturucular

ContainerClient(string, PipelineLike)

ContainerClient'ın bir örneğini oluşturur. Bu yöntem kapsayıcıya işaret eden bir URL kabul eder. Kodlanmış URL dizesi iki kez kaçılmaz, yalnızca URL yolundaki özel karakterlerden kaçış karakteri kullanılır. Blob adında ? varsa veya %, blob adı URL'de kodlanmalıdır.
ContainerClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

ContainerClient örneği oluşturur.

Özellikler

containerName

Kapsayıcının adı.

Devralınan Özellikler

accountName
credential

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

Kodlanmış URL dizesi değeri.

Yöntemler

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.

Bkz https://docs.microsoft.com/en-us/rest/api/storageservices/create-container . Adlandırma kuralları: Bkz. https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
createIfNotExists(ContainerCreateOptions)

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

Bkz https://docs.microsoft.com/en-us/rest/api/storageservices/create-container . Adlandırma kuralları: Bkz. https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
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.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container
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.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
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.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container
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. Bu işlev tamamlandıktan sonra aynı ada sahip yeni kapsayıcılar diğer istemciler veya uygulamalar tarafından eklenebilir.
findBlobsByTags(string, ContainerFindBlobByTagsOptions)

Belirtilen kapsayıcı altında belirtilen etikete sahip tüm blobları bulmak için zaman uyumsuz yinelenebilir bir yineleyici döndürür.

.byPage() sayfalardaki blobları listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür.

Söz dizimi kullanan for await örnek:

let i = 1;
for await (const blob of containerClient.findBlobsByTags("tagkey='tagvalue'")) {
  console.log(`Blob ${i++}: ${blob.name}`);
}

kullanan iter.next()örnek:

let i = 1;
const iter = containerClient.findBlobsByTags("tagkey='tagvalue'");
let blobItem = await iter.next();
while (!blobItem.done) {
  console.log(`Blob ${i++}: ${blobItem.value.name}`);
  blobItem = await iter.next();
}

kullanan byPage()örnek:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of containerClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 20 })) {
  if (response.blobs) {
    for (const blob of response.blobs) {
      console.log(`Blob ${i++}: ${blob.name}`);
    }
  }
}

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

let i = 1;
let iterator = containerClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

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

// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = containerClient
  .findBlobsByTags("tagkey='tagvalue'")
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints blob names
if (response.blobs) {
  for (const blob of response.blobs) {
     console.log(`Blob ${i++}: ${blob.name}`);
  }
}
generateSasUrl(ContainerGenerateSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle inşa edilen 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.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(ContainerGetAccessPolicyOptions)

Belirtilen kapsayıcının izinlerini alır. İzinler, kapsayıcı verilerine genel olarak erişilip erişilemeyeceğini gösterir.

UYARI: StartsOn ve expiresOn dizeleri ayrıştırılırken JavaScript Tarihi duyarlılığı kaybedebilir. Örneğin, yeni Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z" değerini alır.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl
getAppendBlobClient(string)

AppendBlobClient oluşturur
getBlobBatchClient()

Toplu işlemleri gerçekleştirmek için bir BlobBatchClient nesnesi oluşturur.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
getBlobClient(string)

BlobClient oluşturur
getBlobLeaseClient(string)

Kapsayıcıdaki kiraları yöneten bir BlobLeaseClient alın.
getBlockBlobClient(string)

BlockBlobClient oluşturur
getPageBlobClient(string)

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.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-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 includeMetadataBlobServiceClient yöntemi tarafından listContainers döndürülen meta veri anahtarlarından farklıdır.
listBlobsByHierarchy(string, ContainerListBlobsOptions)

Tüm blobları hiyerarşiye göre listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür. öğesini seçin.

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

Söz dizimi kullanan for await örnek:

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

kullanan iter.next()ö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}`);
  }
  entity = await iter.next();
}

kullanan byPage()ö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}`);
  }
}

En büyük sayfa boyutuna sahip disk belleği 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}`);
  }
}
listBlobsFlat(ContainerListBlobsOptions)

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

.byPage() sayfalardaki blobları listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür.

Söz dizimi kullanan for await ö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}`);
}

kullanan iter.next()ö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();
}

kullanan byPage()ö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.

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 depolanmış erişim ilkesi oluşturduğunuzda, etkili olması 30 saniyeye 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.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl
setMetadata(Metadata, ContainerSetMetadataOptions)

Belirtilen kapsayıcı için bir veya daha fazla kullanıcı tanımlı ad-değer çifti ayarlar.

Hiçbir seçenek sağlanmadıysa veya parametrede tanımlı meta veri yoksa kapsayıcı meta verileri kaldırılır.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata
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, blobdaki mevcut meta verilerin üzerine yazılır. Kısmi güncelleştirmeler desteklenmez; yeni içerikle mevcut blobun içeriğinin üzerine yazılır. Blok bloblarının kısmi güncelleştirmesini gerçekleştirmek için stageBlock ve commitBlockList kullanın.

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

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

Oluşturucu Ayrıntıları

ContainerClient(string, PipelineLike)

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

new ContainerClient(url: string, pipeline: PipelineLike)

Parametreler

url

string

Azure Depolama kapsayıcısına işaret eden "https://myaccount.blob.core.windows.net/mycontainer". AnonymousCredential kullanıyorsanız SAS ekleyebilirsiniz; örneğin, "https://myaccount.blob.core.windows.net/mycontainer?sasString".

pipeline
PipelineLike

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

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

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

new 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". AnonymousCredential kullanıyorsanız bir SAS ekleyebilirsiniz; örneğin, "https://myaccount.blob.core.windows.net/mycontainer?sasString".

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.

ContainerClient(string, string, StoragePipelineOptions)

ContainerClient örneği oluşturur.

new ContainerClient(connectionString: string, containerName: 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ı.

options
StoragePipelineOptions

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

Özellik Ayrıntıları

containerName

Kapsayıcının adı.

string containerName

Özellik Değeri

string

Devralınan Özellik Detayları

accountName 

accountName: string

Özellik Değeri

string

Devralınan StorageClient.accountName

credential

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Özellik Değeri

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Devralınan StorageClient.credential

url

Kodlanmış URL dizesi değeri.

url: string

Özellik Değeri

string

Devralınan StorageClient.url

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.

Bkz https://docs.microsoft.com/en-us/rest/api/storageservices/create-container . Adlandırma kuralları: Bkz. https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

function create(options?: ContainerCreateOptions): Promise<ContainerCreateResponse>

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

Promise<ContainerCreateResponse>

createIfNotExists(ContainerCreateOptions)

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

Bkz https://docs.microsoft.com/en-us/rest/api/storageservices/create-container . Adlandırma kuralları: Bkz. https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

function createIfNotExists(options?: ContainerCreateOptions): Promise<ContainerCreateIfNotExistsResponse>

Parametreler

options
ContainerCreateOptions

Döndürülenler

Promise<ContainerCreateIfNotExistsResponse>

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.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container

function delete(options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteResponse>

Parametreler

options
ContainerDeleteMethodOptions

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

Döndürülenler

Promise<ContainerDeleteResponse>

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.

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

function deleteBlob(blobName: string, options?: ContainerDeleteBlobOptions): Promise<BlobDeleteResponse>

Parametreler

blobName

string

options
ContainerDeleteBlobOptions

Blob Silme işlemi seçenekleri.

Döndürülenler

Promise<BlobDeleteResponse>

Blob silme yanıt verilerini engelleyin.

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.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container

function deleteIfExists(options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteIfExistsResponse>

Parametreler

options
ContainerDeleteMethodOptions

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

Döndürülenler

Promise<ContainerDeleteIfExistsResponse>

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. Bu işlev tamamlandıktan sonra aynı ada sahip yeni kapsayıcılar diğer istemciler veya uygulamalar tarafından eklenebilir.

function exists(options?: ContainerExistsOptions): Promise<boolean>

Parametreler

options
ContainerExistsOptions

Döndürülenler

Promise<boolean>

findBlobsByTags(string, ContainerFindBlobByTagsOptions)

Belirtilen kapsayıcı altında belirtilen etikete sahip tüm blobları bulmak için zaman uyumsuz yinelenebilir bir yineleyici döndürür.

.byPage() sayfalardaki blobları listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür.

Söz dizimi kullanan for await örnek:

let i = 1;
for await (const blob of containerClient.findBlobsByTags("tagkey='tagvalue'")) {
  console.log(`Blob ${i++}: ${blob.name}`);
}

kullanan iter.next()örnek:

let i = 1;
const iter = containerClient.findBlobsByTags("tagkey='tagvalue'");
let blobItem = await iter.next();
while (!blobItem.done) {
  console.log(`Blob ${i++}: ${blobItem.value.name}`);
  blobItem = await iter.next();
}

kullanan byPage()örnek:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of containerClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 20 })) {
  if (response.blobs) {
    for (const blob of response.blobs) {
      console.log(`Blob ${i++}: ${blob.name}`);
    }
  }
}

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

let i = 1;
let iterator = containerClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

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

// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = containerClient
  .findBlobsByTags("tagkey='tagvalue'")
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

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

function findBlobsByTags(tagFilterSqlExpression: string, options?: ContainerFindBlobByTagsOptions): PagedAsyncIterableIterator<FilterBlobItem, ContainerFindBlobsByTagsSegmentResponse, PageSettings>

Parametreler

tagFilterSqlExpression

string

where parametresi, çağıranın etiketleri belirli bir ifadeyle eşleşen blobları sorgulamasını sağlar. Bir blob'un sonuçlarda döndürülebilmesi için verilen ifadenin true olarak değerlendirilmesi gerekir. [OData - ABNF] filtre söz dizimi kuralı, where sorgu parametresinin değeri için resmi dil bilgisini tanımlar; ancak Blob hizmetinde OData filtresi söz diziminin yalnızca bir alt kümesi desteklenir.

options
ContainerFindBlobByTagsOptions

Blobları etiketlere göre bulma seçenekleri.

Döndürülenler

PagedAsyncIterableIterator<FilterBlobItem, ContainerFindBlobsByTagsSegmentResponse, PageSettings>

generateSasUrl(ContainerGenerateSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle inşa edilen 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.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: ContainerGenerateSasUrlOptions): Promise<string>

Parametreler

options
ContainerGenerateSasUrlOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<string>

Bu istemci tarafından temsil edilen kaynağın URI'sini içeren SAS URI'sini ve ardından oluşturulan SAS belirtecini izler.

getAccessPolicy(ContainerGetAccessPolicyOptions)

Belirtilen kapsayıcının izinlerini alır. İzinler, kapsayıcı verilerine genel olarak erişilip erişilemeyeceğini gösterir.

UYARI: StartsOn ve expiresOn dizeleri ayrıştırılırken JavaScript Tarihi duyarlılığı kaybedebilir. Örneğin, yeni Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z" değerini alır.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl

function getAccessPolicy(options?: ContainerGetAccessPolicyOptions): Promise<ContainerGetAccessPolicyResponse>

Parametreler

options
ContainerGetAccessPolicyOptions

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

Döndürülenler

Promise<ContainerGetAccessPolicyResponse>

getAppendBlobClient(string)

AppendBlobClient oluşturur

function getAppendBlobClient(blobName: string): AppendBlobClient

Parametreler

blobName

string

Ekleme blobu adı

Döndürülenler

AppendBlobClient

getBlobBatchClient()

Toplu işlemleri gerçekleştirmek için bir BlobBatchClient nesnesi oluşturur.

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

function getBlobBatchClient(): BlobBatchClient

Döndürülenler

BlobBatchClient

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

getBlobClient(string)

BlobClient oluşturur

function getBlobClient(blobName: string): BlobClient

Parametreler

blobName

string

Blob adı

Döndürülenler

BlobClient

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

getBlobLeaseClient(string)

Kapsayıcıdaki kiraları yöneten bir BlobLeaseClient alın.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parametreler

proposeLeaseId

string

İlk önerilen kira kimliği.

Döndürülenler

BlobLeaseClient

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

getBlockBlobClient(string)

BlockBlobClient oluşturur

function getBlockBlobClient(blobName: string): BlockBlobClient

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

BlockBlobClient

getPageBlobClient(string)

PageBlobClient oluşturur

function getPageBlobClient(blobName: string): PageBlobClient

Parametreler

blobName

string

Sayfa blobu adı

Döndürülenler

PageBlobClient

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.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-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 includeMetadataBlobServiceClient yöntemi tarafından listContainers döndürülen meta veri anahtarlarından farklıdır.

function getProperties(options?: ContainerGetPropertiesOptions): Promise<ContainerGetPropertiesResponse>

Parametreler

options
ContainerGetPropertiesOptions

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

Döndürülenler

Promise<ContainerGetPropertiesResponse>

listBlobsByHierarchy(string, ContainerListBlobsOptions)

Tüm blobları hiyerarşiye göre listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür. öğesini seçin.

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

Söz dizimi kullanan for await örnek:

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

kullanan iter.next()ö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}`);
  }
  entity = await iter.next();
}

kullanan byPage()ö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}`);
  }
}

En büyük sayfa boyutuna sahip disk belleği 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}`);
  }
}

function listBlobsByHierarchy(delimiter: string, options?: ContainerListBlobsOptions): PagedAsyncIterableIterator<({ kind: "prefix" } & BlobPrefix) | ({ kind: "blob" } & BlobItem), ContainerListBlobHierarchySegmentResponse, PageSettings>

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<({ kind: "prefix" } & BlobPrefix) | ({ kind: "blob" } & BlobItem), ContainerListBlobHierarchySegmentResponse, PageSettings>

listBlobsFlat(ContainerListBlobsOptions)

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

.byPage() sayfalardaki blobları listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür.

Söz dizimi kullanan for await ö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}`);
}

kullanan iter.next()ö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();
}

kullanan byPage()ö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): PagedAsyncIterableIterator<BlobItem, ContainerListBlobFlatSegmentResponse, PageSettings>

Parametreler

options
ContainerListBlobsOptions

Blobları listeleme seçenekleri.

Döndürülenler

PagedAsyncIterableIterator<BlobItem, ContainerListBlobFlatSegmentResponse, PageSettings>

Disk belleğini destekleyen bir 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.

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 depolanmış erişim ilkesi oluşturduğunuzda, etkili olması 30 saniyeye 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.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl

function setAccessPolicy(access?: PublicAccessType, containerAcl?: SignedIdentifier[], options?: ContainerSetAccessPolicyOptions): Promise<ContainerSetAccessPolicyResponse>

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

Promise<ContainerSetAccessPolicyResponse>

setMetadata(Metadata, ContainerSetMetadataOptions)

Belirtilen kapsayıcı için bir veya daha fazla kullanıcı tanımlı ad-değer çifti ayarlar.

Hiçbir seçenek sağlanmadıysa veya parametrede tanımlı meta veri yoksa kapsayıcı meta verileri kaldırılır.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata

function setMetadata(metadata?: Metadata, options?: ContainerSetMetadataOptions): Promise<ContainerSetMetadataResponse>

Parametreler

metadata
Metadata

Mevcut 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 Veri işlemi seçenekleri.

Döndürülenler

Promise<ContainerSetMetadataResponse>

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, blobdaki mevcut meta verilerin üzerine yazılır. Kısmi güncelleştirmeler desteklenmez; yeni içerikle mevcut blobun içeriğinin üzerine yazılır. Blok bloblarının kısmi güncelleştirmesini gerçekleştirmek için stageBlock ve commitBlockList kullanın.

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

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

function uploadBlockBlob(blobName: string, body: HttpRequestBody, contentLength: number, options?: BlockBlobUploadOptions): Promise<{ blockBlobClient: BlockBlobClient, response: BlockBlobUploadResponse }>

Parametreler

blobName

string

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

body
HttpRequestBody

Blob, string, 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 kodlanmış olmayan 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<{ blockBlobClient: BlockBlobClient, response: BlockBlobUploadResponse }>

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