ContainerClient class

ContainerClient のインスタンスを作成します。 このメソッドは、コンテナーを指す URL を受け入れます。 エンコードされた URL 文字列は 2 回エスケープされず、URL パス内の特殊文字のみがエスケープされます。 BLOB 名に含まれている場合は ? または %、BLOB 名を URL でエンコードする必要があります。

new ContainerClient(url: string, pipeline: PipelineLike)

パラメーター

ContainerClient のインスタンスを作成します。 このメソッドは、コンテナーを指す URL を受け入れます。 エンコードされた URL 文字列は 2 回エスケープされず、URL パス内の特殊文字のみがエスケープされます。 BLOB 名に含まれている場合は ? または %、BLOB 名を URL でエンコードする必要があります。

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

パラメーター

ContainerClient のインスタンスを作成します。

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

パラメーター

コンテナーの名前。

string containerName

プロパティ値

accountName: string

プロパティ値

StorageClient.accountName から継承された

AnonymousCredential、StorageSharedKeyCredential、サービスへの要求を認証するための @azure/identity パッケージの資格情報など。 TokenCredential インターフェイスを実装するオブジェクトを指定することもできます。 指定しない場合は、AnonymousCredential が使用されます。

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

プロパティ値

StorageClient.credential から継承された

エンコードされた URL 文字列値。

url: string

プロパティ値

StorageClient.url から継承された

指定したアカウントの下に新しいコンテナーを作成します。 同じ名前のコンテナーが既に存在する場合、操作は失敗します。

https://docs.microsoft.com/en-us/rest/api/storageservices/create-container 名前付け規則を参照してください。https://video2.skills-academy.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata を参照してください

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

パラメーター

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

戻り値

指定したアカウントの下に新しいコンテナーを作成します。 同じ名前のコンテナーが既に存在する場合、変更されません。

https://docs.microsoft.com/en-us/rest/api/storageservices/create-container 名前付け規則を参照してください。https://video2.skills-academy.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata を参照してください

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

パラメーター

戻り値

指定したコンテナーを削除対象としてマークします。 コンテナーとその中に含まれる BLOB は、後でガベージ コレクション中に削除されます。

https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container を参照してください

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

パラメーター

戻り値

指定した BLOB またはスナップショットを削除対象としてマークします。 BLOB は後でガベージ コレクション中に削除されます。 BLOB を削除するには、そのすべてのスナップショットを削除する必要があることに注意してください。 BLOB の削除操作では、両方を同時に削除できます。

https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob を参照してください

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

パラメーター

戻り値

BLOB 削除応答データをブロックします。

指定したコンテナーが存在する場合は、削除対象としてマークします。 コンテナーとその中に含まれる BLOB は、後でガベージ コレクション中に削除されます。

https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container を参照してください

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

パラメーター

戻り値

このクライアントによって表される Azure コンテナー リソースが存在する場合は true を返します。それ以外の場合は false。

注: 既存のコンテナーは他のクライアントまたはアプリケーションによって削除される可能性があるため、この関数は注意して使用してください。 その逆も同じ名前の新しいコンテナーは、この関数の完了後に他のクライアントまたはアプリケーションによって追加される可能性があります。

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

パラメーター

戻り値

指定したコンテナーの下で、指定したタグを持つすべての BLOB を検索する非同期反復可能な反復子を返します。

.byPage() は、ページ内の BLOB を一覧表示する非同期反復可能な反復子を返します。

for await 構文の使用例:

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

iter.next()の使用例:

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()の使用例:

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

マーカーでのページングの使用例:

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>

パラメーター

戻り値

共有キー資格情報を使用して構築された ContainerClient でのみ使用できます。

渡されたクライアントのプロパティとパラメーターに基づいて、BLOB コンテナー サービス Shared Access Signature (SAS) URI を生成します。 SAS は、クライアントの共有キー資格情報によって署名されます。

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas を参照してください

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

パラメーター

戻り値

このクライアントによって表されるリソースへの URI と、生成された SAS トークンで構成される SAS URI。

指定したコンテナーのアクセス許可を取得します。 アクセス許可は、コンテナー データにパブリックにアクセスできるかどうかを示します。

警告: startsOn 文字列と expiresOn 文字列を解析すると、JavaScript 日付の精度が失われる可能性があります。 たとえば、新しい Date("2018-12-31T03:44:23.8827891Z").toISOString() は "2018-12-31T03:44:23.882Z" を取得します。

https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl を参照してください

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

パラメーター

戻り値

アカウント情報の取得操作は、指定されたアカウントの SKU 名とアカウントの種類を返します。 アカウント情報の取得操作は、バージョン 2018-03-28 以降のサービス バージョンで使用できます。

https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information を参照してください

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

パラメーター

戻り値

サービスアカウント情報の取得操作の応答データ。

AppendBlobClient を作成します。

function getAppendBlobClient(blobName: string): AppendBlobClient

パラメーター

戻り値

バッチ操作を実行する BlobBatchClient オブジェクトを作成します。

https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch を参照してください

function getBlobBatchClient(): BlobBatchClient

戻り値

このコンテナーの新しい BlobBatchClient オブジェクト。

BlobClient を作成します

function getBlobClient(blobName: string): BlobClient

パラメーター

戻り値

指定された BLOB 名の新しい BlobClient オブジェクト。

コンテナーのリースを管理する BlobLeaseClient を取得します。

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

パラメーター

戻り値

コンテナーのリースを管理するための新しい BlobLeaseClient オブジェクト。

BlockBlobClient を作成します。

function getBlockBlobClient(blobName: string): BlockBlobClient

パラメーター

const content = "Hello world!";

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

戻り値

PageBlobClient を作成します。

function getPageBlobClient(blobName: string): PageBlobClient

パラメーター

戻り値

指定したコンテナーのすべてのユーザー定義メタデータとシステム プロパティを返します。 返されるデータには、コンテナーの BLOB の一覧は含まれません。

https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties を参照してください

警告: 応答で返される metadata オブジェクトのキーは、最初に大文字が含まれていた場合でも小文字になります。 これは、 オプションを使用して BlobServiceClient を する メソッドによって返されるメタデータ キーとは異なり、元の大文字と小文字が保持されます。

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

パラメーター

戻り値

階層ごとにすべての BLOB を一覧表示する非同期反復可能な反復子を返します。 指定したアカウントの下に表示されます。

.byPage() は非同期反復可能な反復子を返し、ページ内の階層別に BLOB を一覧表示します。

for await 構文の使用例:

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()の使用例:

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()の使用例:

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

最大ページ サイズでページングを使用する例:

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>

パラメーター

戻り値

指定されたアカウントのすべての BLOB を一覧表示する非同期反復可能な反復子を返します。

.byPage() は、ページ内の BLOB を一覧表示する非同期反復可能な反復子を返します。

for await 構文の使用例:

// 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()の使用例:

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()の使用例:

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

マーカーでのページングの使用例:

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>

パラメーター

戻り値

ページングをサポートする asyncIterableIterator。

指定したコンテナーのアクセス許可を設定します。 このアクセス許可は、コンテナー内の BLOB にパブリックにアクセスできるかどうかを示します。

コンテナーのアクセス許可を設定すると、既存のアクセス許可が置き換えられます。 アクセスまたは containerAcl が指定されていない場合は、既存のコンテナー ACL が削除されます。

コンテナーに保存されているアクセス ポリシーを確立すると、有効になるまでに最大 30 秒かかる場合があります。 この期間中、保存されているアクセス ポリシーに関連付けられている共有アクセス署名は、アクセス ポリシーがアクティブになるまで、状態コード 403 (禁止) で失敗します。

https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl を参照してください

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

パラメーター

戻り値

指定したコンテナーの 1 つ以上のユーザー定義の名前と値のペアを設定します。

オプションが指定されていない場合、またはパラメーターにメタデータが定義されていない場合は、コンテナー メタデータが削除されます。

https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata を参照してください

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

パラメーター

戻り値

新しいブロック BLOB を作成するか、既存のブロック BLOB のコンテンツを更新します。

既存のブロック BLOB を更新すると、BLOB 上の既存のメタデータが上書きされます。 部分的な更新はサポートされていません。既存の BLOB のコンテンツが新しいコンテンツで上書きされます。 ブロック BLOB の部分的な更新を実行するには、stageBlock 使用し、commitBlockListを します。

これは非並列アップロード方法です。uploadFile、uploadStream、または uploadBrowserData を して、コンカレンシー アップロードのパフォーマンスを向上してください。

https://docs.microsoft.com/rest/api/storageservices/put-blob を参照してください

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

パラメーター

戻り値

ブロック BLOB アップロード応答データと対応する BlockBlobClient インスタンス。