ContainerClient class

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

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

ContainerClient örneği oluşturur.

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

Parametreler

Kapsayıcının adı.

string containerName

Özellik Değeri

accountName: string

Özellik Değeri

StorageClient.accountName'den Devralınan

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

StorageClient.credential'dan Devralınmış

Kodlanmış URL dizesi değeri.

url: string

Özellik Değeri

StorageClient.url'den Devralınan

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://video2.skills-academy.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

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

Parametreler

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

Döndürülenler

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://video2.skills-academy.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

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

Parametreler

Döndürülenler

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

Döndürülenler

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

Döndürülenler

Blob silme yanıt verilerini engelle.

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

Döndürülenler

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): Promise<boolean>

Parametreler

Döndürülenler

Belirtilen kapsayıcı altında belirtilen etikete sahip tüm blobları bulmak 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:

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

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

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

Döndürülenler

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.

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

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

Parametreler

Döndürülenler

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

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.

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

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

Parametreler

Döndürülenler

Hesap Bilgilerini Al işlemi, belirtilen hesap için sku adını ve hesap türünü döndürür. Hesap Bilgilerini Al işlemi, sürüm 2018-03-28 ile başlayan hizmet sürümlerinde kullanılabilir.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information

function getAccountInfo(options?: ContainerGetAccountInfoOptions): Promise<ContainerGetAccountInfoResponse>

Parametreler

Döndürülenler

Hizmet Hesap Bilgilerini Al işlemi için yanıt verileri.

AppendBlobClient oluşturur

function getAppendBlobClient(blobName: string): AppendBlobClient

Parametreler

Döndürülenler

Toplu işlemleri yürütmek 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

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

BlobClient oluşturur

function getBlobClient(blobName: string): BlobClient

Parametreler

Döndürülenler

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

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

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parametreler

Döndürülenler

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

BlockBlobClient oluşturur

function getBlockBlobClient(blobName: string): BlockBlobClient

Parametreler

const content = "Hello world!";

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

Döndürülenler

PageBlobClient oluşturur

function getPageBlobClient(blobName: string): PageBlobClient

Parametreler

Döndürülenler

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 döndürülen metadata nesnesinin 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 includeMetadata seçeneğini kullanarak BlobServiceClientlistContainers yöntemi tarafından döndürülen meta veri anahtarlarından farklıdır.

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

Parametreler

Döndürülenler

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}`);
  }
}

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}`);
  }
  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}`);
  }
}

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}`);
  }
}

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

Parametreler

Döndürülenler

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): PagedAsyncIterableIterator<BlobItem, ContainerListBlobFlatSegmentResponse, PageSettings>

Parametreler

Döndürülenler

Disk belleğini destekleyen asyncIterableIterator.

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.

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

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

Parametreler

Döndürülenler

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.

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

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

Parametreler

Döndürülenler

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 stageBlock kullanın ve commitBlockList.

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

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

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

Parametreler

Döndürülenler

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