Class ContainerClient

Creates an instance of ContainerClient.

Creates an instance of ContainerClient. This method accepts an URL pointing to a container. Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. If a blob name includes ? or %, blob name must be encoded in the URL.

Creates an instance of ContainerClient. This method accepts an URL pointing to a container. Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. If a blob name includes ? or %, blob name must be encoded in the URL.

The name of the container.

Creates a new container under the specified account. If the container with the same name already exists, the operation fails.

Creates a new container under the specified account. If the container with the same name already exists, it is not changed.

Marks the specified container for deletion. The container and any blobs contained within it are later deleted during garbage collection.

Marks the specified blob or snapshot for deletion. The blob is later deleted during garbage collection. Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time with the Delete Blob operation.

Marks the specified container for deletion if it exists. The container and any blobs contained within it are later deleted during garbage collection.

Returns true if the Azure container resource represented by this client exists; false otherwise.

NOTE: use this function with care since an existing container might be deleted by other clients or applications. Vice versa new containers with the same name might be added by other clients or applications after this function completes.

Returns an async iterable iterator to find all blobs with specified tag under the specified container.

.byPage() returns an async iterable iterator to list the blobs in pages.

Example using for await syntax:

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const containerClient = blobServiceClient.getContainerClient(containerName);

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

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

// Example using `byPage()` syntax
i = 1;
for await (const page of containerClient
  .findBlobsByTags("tagkey='tagvalue'")
  .byPage({ maxPageSize: 20 })) {
  for (const blob of page.blobs) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}

// Example using paging with a marker
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 10 blob names
if (response.blobs) {
  for (const blob of response.blobs) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}
Copy

Only available for ContainerClient constructed with a shared key credential.

Generates string to sign for a Blob Container Service Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.

Only available for ContainerClient constructed with a shared key credential.

Generates a Blob Container Service Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.

Generates string to sign for a Blob Container Service Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the input user delegation key.

Generates a Blob Container Service Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the input user delegation key.

Gets the permissions for the specified container. The permissions indicate whether container data may be accessed publicly.

WARNING: JavaScript Date will potentially lose precision when parsing startsOn and expiresOn strings. For example, new Date("2018-12-31T03:44:23.8827891Z").toISOString() will get "2018-12-31T03:44:23.882Z".

The Get Account Information operation returns the sku name and account kind for the specified account. The Get Account Information operation is available on service versions beginning with version 2018-03-28.

Creates an AppendBlobClient

Creates a BlobBatchClient object to conduct batch operations.

Creates a BlobClient

Get a BlobLeaseClient that manages leases on the container.

Creates a BlockBlobClient

Creates a PageBlobClient

Returns all user-defined metadata and system properties for the specified container. The data returned does not include the container's list of blobs.

Returns an async iterable iterator to list all the blobs by hierarchy. under the specified account.

.byPage() returns an async iterable iterator to list the blobs by hierarchy in pages.

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const containerClient = blobServiceClient.getContainerClient(containerName);

// Example using `for await` syntax
let i = 1;
const blobs = containerClient.listBlobsByHierarchy("/");
for await (const blob of blobs) {
  if (blob.kind === "prefix") {
    console.log(`\tBlobPrefix: ${blob.name}`);
  } else {
    console.log(`\tBlobItem: name - ${blob.name}`);
  }
}

// Example using `iter.next()` syntax
i = 1;
const iter = containerClient.listBlobsByHierarchy("/");
let { value, done } = await iter.next();
while (!done) {
  if (value.kind === "prefix") {
    console.log(`\tBlobPrefix: ${value.name}`);
  } else {
    console.log(`\tBlobItem: name - ${value.name}`);
  }
  ({ value, done } = await iter.next());
}

// Example using `byPage()` syntax
i = 1;
for await (const page of containerClient.listBlobsByHierarchy("/").byPage({ maxPageSize: 20 })) {
  const segment = page.segment;
  if (segment.blobPrefixes) {
    for (const prefix of segment.blobPrefixes) {
      console.log(`\tBlobPrefix: ${prefix.name}`);
    }
  }
  for (const blob of page.segment.blobItems) {
    console.log(`\tBlobItem: name - ${blob.name}`);
  }
}

// Example using paging with a marker
i = 1;
let iterator = containerClient.listBlobsByHierarchy("/").byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 blob names
if (response.blobPrefixes) {
  for (const prefix of response.blobPrefixes) {
    console.log(`\tBlobPrefix: ${prefix.name}`);
  }
}
if (response.segment.blobItems) {
  for (const blob of response.segment.blobItems) {
    console.log(`\tBlobItem: name - ${blob.name}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = containerClient
  .listBlobsByHierarchy("/")
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 blob names
if (response.blobPrefixes) {
  for (const prefix of response.blobPrefixes) {
    console.log(`\tBlobPrefix: ${prefix.name}`);
  }
}
if (response.segment.blobItems) {
  for (const blob of response.segment.blobItems) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}
Copy

Returns an async iterable iterator to list all the blobs under the specified account.

.byPage() returns an async iterable iterator to list the blobs in pages.

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const containerClient = blobServiceClient.getContainerClient(containerName);

// Example using `for await` syntax
let i = 1;
const blobs = containerClient.listBlobsFlat();
for await (const blob of blobs) {
  console.log(`Blob ${i++}: ${blob.name}`);
}

// Example using `iter.next()` syntax
i = 1;
const iter = containerClient.listBlobsFlat();
let { value, done } = await iter.next();
while (!done) {
  console.log(`Blob ${i++}: ${value.name}`);
  ({ value, done } = await iter.next());
}

// Example using `byPage()` syntax
i = 1;
for await (const page of containerClient.listBlobsFlat().byPage({ maxPageSize: 20 })) {
  for (const blob of page.segment.blobItems) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}

// Example using paging with a marker
i = 1;
let iterator = containerClient.listBlobsFlat().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 blob names
if (response.segment.blobItems) {
  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
if (response.segment.blobItems) {
  for (const blob of response.segment.blobItems) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}
Copy

Sets the permissions for the specified container. The permissions indicate whether blobs in a container may be accessed publicly.

When you set permissions for a container, the existing permissions are replaced. If no access or containerAcl provided, the existing container ACL will be removed.

When you establish a stored access policy on a container, it may take up to 30 seconds to take effect. During this interval, a shared access signature that is associated with the stored access policy will fail with status code 403 (Forbidden), until the access policy becomes active.

Sets one or more user-defined name-value pairs for the specified container.

If no option provided, or no metadata defined in the parameter, the container metadata will be removed.

Creates a new block blob, or updates the content of an existing block blob.

Updating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported; the content of the existing blob is overwritten with the new content. To perform a partial update of a block blob's, use BlockBlobClient.stageBlock and BlockBlobClient.commitBlockList.

This is a non-parallel uploading method, please use BlockBlobClient.uploadFile, BlockBlobClient.uploadStream or BlockBlobClient.uploadBrowserData for better performance with concurrency uploading.