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 %, blobnamnet måste vara kodat 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 %, blobnamnet måste vara kodat 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

accountName: string

Egenskapsvärde

Namnet på containern.

string containerName

Egenskapsvärde

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Egenskapsvärde

Kodat URL-strängvärde.

url: string

Egenskapsvärde

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

function create(options?: ContainerCreateOptions)

Parametrar

const containerClient = blobServiceClient.getContainerClient("<container name>");
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.

function createIfNotExists(options?: ContainerCreateOptions)

Parametrar

Returer

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

function delete(options?: ContainerDeleteMethodOptions)

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.

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

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.

function deleteIfExists(options?: ContainerDeleteMethodOptions)

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. Tvärtom kan nya containrar med samma namn läggas till av andra klienter eller program när den här funktionen har slutförts.

function exists(options?: ContainerExistsOptions)

Parametrar

Returer

Endast tillgängligt för ContainerClient som skapats med en autentiseringsuppgift med delad nyckel. Genererar en SAS-URI (Blob Container Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

function generateSasUrl(options: ContainerGenerateSasUrlOptions)

Parametrar

Returer

SAS-URI:n som består av URI:n för 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 kan förlora precision när startsOn parsas och expiresOn-strängar. Till exempel får nya Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z".

function getAccessPolicy(options?: ContainerGetAccessPolicyOptions)

Parametrar

Returer

Skapar en <xref:AppendBlobClient>

function getAppendBlobClient(blobName: string)

Parametrar

Returer

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

function getBlobBatchClient()

Returer

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

Skapar en <xref:BlobClient>

function getBlobClient(blobName: string)

Parametrar

Returer

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

Hämta en <xref:BlobLeaseClient> som hanterar lån på containern.

function getBlobLeaseClient(proposeLeaseId?: string)

Parametrar

Returer

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

Skapar en <xref:BlockBlobClient>

function getBlockBlobClient(blobName: string)

Parametrar

const content = "Hello world!";

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

Returer

Skapar en <xref:PageBlobClient>

function getPageBlobClient(blobName: string)

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.

function getProperties(options?: ContainerGetPropertiesOptions)

Parametrar

Returer

Returnerar en asynkron iterbar iterator för att visa en lista över alla blobar efter hierarki. under det angivna kontot. .byPage() returnerar en asynkron itererbar iterator för att visa en lista över blobar efter hierarki på sidor.

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

Exempel med 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}, last modified - ${item.properties.lastModified}`);
  }
  entity = await iter.next();
}

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

Exempel med sidindelning med maximal sidstorlek:

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)

Parametrar

Returer

Returnerar en asynkron iterbar iterator 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 en lista över blobarna på sidor.

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

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

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

Exempel med sidindelning med en markör:

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)

Parametrar

Returer

En asyncIterableIterator som stöder sidindelning.

Anger behörigheterna för den angivna containern. Behörigheterna anger om blobar i en container kan kommas åt 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 containerns ACL bort.

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

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

Parametrar

Returer

Anger ett eller flera användardefinierade namn/värde-par för den angivna containern. Om inget alternativ har angetts eller inga metadata definierats i parametern tas containermetadata bort.

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

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 <xref:BlockBlobClient.stageBlock> och <xref:BlockBlobClient.commitBlockList>.

Det här är en icke-parallell uppladdningsmetod, använd <xref:BlockBlobClient.uploadFile><xref:BlockBlobClient.uploadStream> eller <xref:BlockBlobClient.uploadBrowserData> för bättre prestanda med samtidighetsuppladdning.

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

Parametrar

Returer

Svarsdata för blockblobuppladdning och motsvarande BlockBlobClient-instans.