ContainerClient class

ContainerClient örneği oluşturur. Bu yöntem bir kapsayıcıyı işaret eden bir URL 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 ContainerClient(url: string, pipeline: PipelineLike)

Parametreler

ContainerClient örneği oluşturur. Bu yöntem bir kapsayıcıyı işaret eden bir URL 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 ContainerClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parametreler

ContainerClient örneği oluşturur.

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

Parametreler

accountName: string

Özellik Değeri

Kapsayıcının adı.

string containerName

Özellik Değeri

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Özellik Değeri

Kodlanmış URL dizesi değeri.

url: string

Özellik Değeri

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

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.

function createIfNotExists(options?: ContainerCreateOptions)

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.

function delete(options?: ContainerDeleteMethodOptions)

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.

function deleteBlob(blobName: string, options?: ContainerDeleteBlobOptions)

Parametreler

Döndürülenler

Blob silme yanıt verilerini engelleyin.

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

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

Parametreler

Döndürülenler

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.

function generateSasUrl(options: ContainerGenerateSasUrlOptions)

Parametreler

Döndürülenler

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

Belirtilen kapsayıcının izinlerini 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

Döndürülenler

Bir oluşturur <xref:AppendBlobClient>

function getAppendBlobClient(blobName: string)

Parametreler

Döndürülenler

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.

Bir <xref:BlobClient> oluşturur

function getBlobClient(blobName: string)

Parametreler

Döndürülenler

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

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

function getBlobLeaseClient(proposeLeaseId?: string)

Parametreler

Döndürülenler

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

Bir <xref:BlockBlobClient> oluşturur

function getBlockBlobClient(blobName: string)

Parametreler

const content = "Hello world!";

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

Döndürülenler

Bir <xref:PageBlobClient> oluşturur

function getPageBlobClient(blobName: string)

Parametreler

Döndürülenler

Belirtilen kapsayıcı için tüm kullanıcı tanımlı 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

Döndürülenler

Hiyerarşiye göre tüm blobları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür. ögesini seçin. .byPage() blobları sayfalardaki hiyerarşiye göre listelemek için zaman uyumsuz bir yinelenebilir 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}, last modified - ${item.properties.lastModified}`);
  }
}

kullanma iter.next()örneği:

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

kullanma byPage()örneği:

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

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}, last modified - ${blob.properties.lastModified}`);
  }
}

function listBlobsByHierarchy(delimiter: string, options?: ContainerListBlobsOptions)

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.

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

kullanma iter.next()örneği:

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

kullanma byPage()örneği:

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

Döndürülenler

Disk belleğini destekleyen asyncIterableIterator.

Belirtilen kapsayıcının izinlerini 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ğlanmazsa, mevcut kapsayıcı ACL'si 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 durum kodu 403 (Yasak) ile başarısız olur.

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

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ğlanmazsa veya parametresinde tanımlı meta veri yoksa kapsayıcı meta verileri kaldırılır.

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

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, blobdaki mevcut meta verilerin üzerine yazar. 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 ve <xref:BlockBlobClient.commitBlockList>kullanın<xref:BlockBlobClient.stageBlock>.

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

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

Parametreler

Döndürülenler

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