ContainerClient class

Skapar en instans av ContainerClient. Den här metoden accepterar en URL som pekar på en container. Kodad URL-sträng kommer INTE att undantagas två gånger, endast specialtecken i URL-sökvägen kommer att undantagas. Om ett blobnamn innehåller ? eller %måste blobnamnet kodas i URL:en.

new ContainerClient(url: string, pipeline: PipelineLike)

Parametrar

Skapar en instans av ContainerClient. Den här metoden accepterar en URL som pekar på en container. Kodad URL-sträng kommer INTE att undantagas två gånger, endast specialtecken i URL-sökvägen kommer att undantagas. Om ett blobnamn innehåller ? eller %måste blobnamnet kodas i URL:en.

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

Parametrar

Skapar en instans av ContainerClient.

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

Parametrar

Namnet på containern.

string containerName

Egenskapsvärde

accountName: string

Egenskapsvärde

ärvd från StorageClient.accountName

Till exempel AnonymousCredential, StorageSharedKeyCredential eller eventuella autentiseringsuppgifter från @azure/identity-paketet för att autentisera begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Egenskapsvärde

ärvd från StorageClient.credential

Kodat URL-strängvärde.

url: string

Egenskapsvärde

ärvd från StorageClient.url

Skapar en ny container under det angivna kontot. Om containern med samma namn redan finns misslyckas åtgärden.

Se https://free.blessedness.top/rest/api/storageservices/create-container namngivningsregler: Se https://free.blessedness.top/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

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

Parametrar

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);
const createContainerResponse = await containerClient.create();
console.log("Container was created successfully", createContainerResponse.requestId);

Returer

Skapar en ny container under det angivna kontot. Om containern med samma namn redan finns ändras den inte.

Se https://free.blessedness.top/rest/api/storageservices/create-container namngivningsregler: Se https://free.blessedness.top/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

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

Parametrar

Returer

Markerar den angivna containern för borttagning. Containern och eventuella blobar som finns i den tas senare bort under skräpinsamlingen.

Se https://free.blessedness.top/rest/api/storageservices/delete-container

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

Parametrar

Returer

Markerar den angivna bloben eller ögonblicksbilden för borttagning. Bloben tas senare bort under skräpinsamlingen. Observera att du måste ta bort alla ögonblicksbilder för att kunna ta bort en blob. Du kan ta bort båda samtidigt med åtgärden Ta bort blob.

Se https://free.blessedness.top/rest/api/storageservices/delete-blob

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

Parametrar

Returer

Blockera svarsdata för borttagning av blobar.

Markerar den angivna containern för borttagning om den finns. Containern och eventuella blobar som finns i den tas senare bort under skräpinsamlingen.

Se https://free.blessedness.top/rest/api/storageservices/delete-container

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

Parametrar

Returer

Returnerar sant om Azure-containerresursen som representeras av den här klienten finns. annars falskt.

Obs! Använd den här funktionen med försiktighet eftersom en befintlig container kan tas bort av andra klienter eller program. Vice versa nya containrar med samma namn kan läggas till av andra klienter eller program när den här funktionen har slutförts.

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

Parametrar

Returer

Returnerar en itererbar iterator för asynkronisering för att hitta alla blobar med angiven tagg under den angivna containern.

.byPage() returnerar en iterator som kan itereras asynkront för att visa blobarna på sidor.

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

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

Parametrar

Returer

Endast tillgängligt för ContainerClient som konstruerats med en delad nyckelautentiseringsuppgift.

Genererar sträng som ska signeras för en SAS-URI (Blob Container Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

Se https://free.blessedness.top/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: ContainerGenerateSasUrlOptions): string

Parametrar

Returer

SAS-URI:n som består av URI:n till den resurs som representeras av den här klienten, följt av den genererade SAS-token.

Endast tillgängligt för ContainerClient som konstruerats med en delad nyckelautentiseringsuppgift.

Genererar en SAS-URI (Blob Container Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

Se https://free.blessedness.top/rest/api/storageservices/constructing-a-service-sas

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

Parametrar

Returer

SAS-URI:n som består av URI:n till den resurs som representeras av den här klienten, följt av den genererade SAS-token.

Genererar sträng som ska signeras för en SAS-URI (Blob Container Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av indataanvändarens delegeringsnyckel.

Se https://free.blessedness.top/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasStringToSign(options: ContainerGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parametrar

Returer

SAS-URI:n som består av URI:n till den resurs som representeras av den här klienten, följt av den genererade SAS-token.

Genererar en SAS-URI (Blob Container Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av indataanvändarens delegeringsnyckel.

Se https://free.blessedness.top/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasUrl(options: ContainerGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

Parametrar

Returer

SAS-URI:n som består av URI:n till den resurs som representeras av den här klienten, följt av den genererade SAS-token.

Hämtar behörigheterna för den angivna containern. Behörigheterna anger om containerdata kan kommas åt offentligt.

VARNING! JavaScript-datum förlorar potentiellt precision vid parsning av startsOn och expiresOn-strängar. Till exempel får nya Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z".

Se https://free.blessedness.top/rest/api/storageservices/get-container-acl

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

Parametrar

Returer

Åtgärden Hämta kontoinformation returnerar sku-namnet och kontotyp för det angivna kontot. Åtgärden Hämta kontoinformation är tillgänglig i tjänstversioner från och med version 2018-03-28.

Se https://free.blessedness.top/rest/api/storageservices/get-account-information

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

Parametrar

Returer

Svarsdata för åtgärden Hämta kontoinformation för tjänsten.

Skapar en AppendBlobClient-

function getAppendBlobClient(blobName: string): AppendBlobClient

Parametrar

Returer

Skapar ett BlobBatchClient-objekt för att utföra batchåtgärder.

Se https://free.blessedness.top/rest/api/storageservices/blob-batch

function getBlobBatchClient(): BlobBatchClient

Returer

Ett nytt BlobBatchClient-objekt för den här containern.

Skapar en BlobClient-

function getBlobClient(blobName: string): BlobClient

Parametrar

Returer

Ett nytt BlobClient-objekt för det angivna blobnamnet.

Hämta en BlobLeaseClient- som hanterar lån på containern.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parametrar

Returer

Ett nytt BlobLeaseClient-objekt för att hantera lån på containern.

Skapar en BlockBlobClient-

function getBlockBlobClient(blobName: string): BlockBlobClient

Parametrar

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 blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blockBlobClient = containerClient.getBlockBlobClient(blobName);

const content = "Hello world!";
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);

Returer

Skapar en PageBlobClient-

function getPageBlobClient(blobName: string): PageBlobClient

Parametrar

Returer

Returnerar alla användardefinierade metadata och systemegenskaper för den angivna containern. De data som returneras innehåller inte containerns lista över blobar.

Se https://free.blessedness.top/rest/api/storageservices/get-container-properties

VARNING! Det metadata objekt som returneras i svaret har sina nycklar i gemener, även om de ursprungligen innehöll versaler. Detta skiljer sig från de metadatanycklar som returneras av metoden listContainers för BlobServiceClient med hjälp av alternativet includeMetadata, som behåller sitt ursprungliga hölje.

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

Parametrar

Returer

Returnerar en iterbar iterator som kan asynkroniseras för att visa en lista över alla blobar efter hierarki. under det angivna kontot.

.byPage() returnerar en iterator som kan itereras asynkront för att lista blobarna efter hierarki på sidor.

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

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

Parametrar

Returer

Returnerar en iterbar iterator som kan asynkroniseras för att visa en lista över alla blobar under det angivna kontot.

.byPage() returnerar en iterator som kan itereras asynkront för att visa blobarna på sidor.

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

function listBlobsFlat(options?: ContainerListBlobsOptions): PagedAsyncIterableIterator<BlobItem, ContainerListBlobFlatSegmentResponse, PageSettings>

Parametrar

Returer

En asyncIterableIterator som stöder växling.

Anger behörigheter för den angivna containern. Behörigheterna anger om blobar i en container kan nås offentligt.

När du anger behörigheter för en container ersätts de befintliga behörigheterna. Om ingen åtkomst eller containerAcl har angetts tas den befintliga container-ACL:n bort.

När du upprättar en lagrad åtkomstprincip på en container kan det ta upp till 30 sekunder att börja gälla. Under det här intervallet misslyckas en signatur för delad åtkomst som är associerad med den lagrade åtkomstprincipen med statuskoden 403 (förbjuden) tills åtkomstprincipen blir aktiv.

Se https://free.blessedness.top/rest/api/storageservices/set-container-acl

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

Parametrar

Returer

Anger ett eller flera användardefinierade namn/värde-par för den angivna containern.

Om inget alternativ har angetts, eller om inga metadata har definierats i parametern, tas containermetadata bort.

Se https://free.blessedness.top/rest/api/storageservices/set-container-metadata

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

Parametrar

Returer

Skapar en ny blockblob eller uppdaterar innehållet i en befintlig blockblob.

Om du uppdaterar en befintlig blockblob skrivs befintliga metadata över på bloben. Partiella uppdateringar stöds inte. innehållet i den befintliga bloben skrivs över med det nya innehållet. Om du vill utföra en partiell uppdatering av en blockblob använder du stageBlock och commitBlockList.

Det här är en icke-parallell uppladdningsmetod. Använd uploadFile, uploadStream eller uploadBrowserData för bättre prestanda vid samtidig uppladdning.

Se https://free.blessedness.top/rest/api/storageservices/put-blob

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

Parametrar

Returer

Blockera blobuppladdningssvarsdata och motsvarande BlockBlobClient-instans.