Megosztás a következőn keresztül:

ContainerClient class

Csomag:
@azure/storage-blob

A ContainerClient az Azure Storage-tároló URL-címét jelöli, amely lehetővé teszi a blobok manipulálását.

Extends

StorageClient

Konstruktorok

ContainerClient(string, PipelineLike)

Létrehozza a ContainerClient egy példányát. Ez a metódus egy tárolóra mutató URL-címet fogad el. A kódolt URL-sztring nem lesz kétszer feloldva, csak az URL-elérési út speciális karakterei lesznek feloldva. Ha egy blobnév tartalmaz? vagy %, a blob nevét az URL-címben kell kódolni.
ContainerClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Létrehozza a ContainerClient egy példányát. Ez a metódus egy tárolóra mutató URL-címet fogad el. A kódolt URL-sztring nem lesz kétszer feloldva, csak az URL-elérési út speciális karakterei lesznek feloldva. Ha egy blobnév tartalmaz? vagy %, a blob nevét az URL-címben kell kódolni.
ContainerClient(string, string, StoragePipelineOptions)

Létrehozza a ContainerClient egy példányát.

Tulajdonságok

containerName

A tároló neve.

Örökölt tulajdonságok

accountName
credential

Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a @azure/identity csomag bármely hitelesítő adata a szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential interfészt. Ha nincs megadva, az AnonymousCredential lesz használva.
url

Kódolt URL-sztringérték.

Metódusok

create(ContainerCreateOptions)

Létrehoz egy új tárolót a megadott fiók alatt. Ha az azonos nevű tároló már létezik, a művelet meghiúsul.

Lásd https://learn.microsoft.com/rest/api/storageservices/create-container elnevezési szabályokat: Lásd: https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
createIfNotExists(ContainerCreateOptions)

Létrehoz egy új tárolót a megadott fiók alatt. Ha az azonos nevű tároló már létezik, az nem módosul.

Lásd https://learn.microsoft.com/rest/api/storageservices/create-container elnevezési szabályokat: Lásd: https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
delete(ContainerDeleteMethodOptions)

Megjelöli a megadott tárolót törlésre. A tároló és a benne található blobok később törlődnek a szemétgyűjtés során.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-container
deleteBlob(string, ContainerDeleteBlobOptions)

Megjelöli a megadott blobot vagy pillanatképet törlésre. A blob később törlődik a szemétgyűjtés során. Vegye figyelembe, hogy egy blob törléséhez törölnie kell az összes pillanatképét. A Blob törlése művelettel egyszerre mindkettő törölhető.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-blob
deleteIfExists(ContainerDeleteMethodOptions)

Megjelöli a megadott tárolót törlésre, ha létezik. A tároló és a benne található blobok később törlődnek a szemétgyűjtés során.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-container
exists(ContainerExistsOptions)

Igaz értéket ad vissza, ha az ügyfél által képviselt Azure-tárolóerőforrás létezik; máskülönben hamis.

MEGJEGYZÉS: Ezt a függvényt körültekintően használja, mivel előfordulhat, hogy egy meglévő tárolót más ügyfelek vagy alkalmazások törölnek. Fordítva, az azonos nevű új tárolókat más ügyfelek vagy alkalmazások is hozzáadhatják a függvény befejeződése után.
findBlobsByTags(string, ContainerFindBlobByTagsOptions)

Egy aszinkron iterátorral adja vissza az összes blobot, amely a megadott címkével rendelkezik a megadott tároló alatt.

A .byPage() aszinkron iterátort ad vissza a lapok blobjainak listázásához.

Példa for await szintaxis használatára:

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

Csak megosztott kulcsú hitelesítő adatokkal létrehozott ContainerClient esetén érhető el.

Sztringet hoz létre a Blob Container Service megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(ContainerGenerateSasUrlOptions)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott ContainerClient esetén érhető el.

Létrehoz egy Blob Container Service Megosztott hozzáférésű jogosultságkód (SAS) URI-t a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasStringToSign(ContainerGenerateSasUrlOptions, UserDelegationKey)

Sztringet hoz létre a Blob Container Service megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t a bemeneti felhasználó delegálási kulcsa írja alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(ContainerGenerateSasUrlOptions, UserDelegationKey)

Létrehoz egy Blob Container Service Megosztott hozzáférésű jogosultságkód (SAS) URI-t a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t a bemeneti felhasználó delegálási kulcsa írja alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(ContainerGetAccessPolicyOptions)

Lekéri a megadott tároló engedélyeit. Az engedélyek azt jelzik, hogy a tárolóadatok nyilvánosan elérhetők-e.

FIGYELMEZTETÉS: A JavaScript-dátum valószínűleg elveszíti a pontosságot a startsOn és a expiresOn sztringek elemzésekor. Például az új Date("2018-12-31T03:44:23.8827891Z").toISOString() a következőt kapja: "2018-12-31T03:44:23.882Z".

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-container-acl
getAccountInfo(ContainerGetAccountInfoOptions)

A Fiókadatok lekérése művelet a megadott fiók termékváltozatának nevét és típusát adja vissza. A Fiókadatok lekérése művelet a 2018-03-28-es verziójú szolgáltatásverziókban érhető el.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-account-information
getAppendBlobClient(string)

Létrehoz egy AppendBlobClient
getBlobBatchClient()

Létrehoz egy BlobBatchClient objektumot a kötegelt műveletek végrehajtásához.

Lásd: https://learn.microsoft.com/rest/api/storageservices/blob-batch
getBlobClient(string)

BlobClient- létrehozása
getBlobLeaseClient(string)

Szerezzen be egy BlobLeaseClient, amely a tárolón lévő bérleteket kezeli.
getBlockBlobClient(string)

Létrehoz egy BlockBlobClient
getPageBlobClient(string)

Létrehoz egy PageBlobClient
getProperties(ContainerGetPropertiesOptions)

A megadott tároló felhasználó által definiált metaadatait és rendszertulajdonságait adja vissza. A visszaadott adatok nem tartalmazzák a tároló bloblistáját.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-container-properties

FIGYELMEZTETÉS: A válaszban visszaadott metadata objektumnak kisbetűs kulcsai lesznek, még akkor is, ha eredetileg nagybetűket tartalmaztak. Ez eltér a BlobServiceClient metódusa által visszaadott metaadatkulcsoktól a beállítással, amely megőrzi az eredeti burkolatot.
listBlobsByHierarchy(string, ContainerListBlobsOptions)

Egy aszinkron iterátort ad vissza az összes blob hierarchia szerinti listázásához. a megadott fiók alatt.

A .byPage() egy aszinkron iterátorral listázhatja a blobokat a lapok hierarchiája szerint.

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

Egy aszinkron iterátort ad vissza, amely felsorolja a megadott fiókban lévő összes blobot.

A .byPage() aszinkron iterátort ad vissza a lapok blobjainak listázásához.

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}`);
  }
}
setAccessPolicy(PublicAccessType, SignedIdentifier[], ContainerSetAccessPolicyOptions)

Beállítja a megadott tároló engedélyeit. Az engedélyek azt jelzik, hogy a tárolóban lévő blobok nyilvánosan elérhetők-e.

Egy tároló engedélyeinek beállításakor a meglévő engedélyek lecserélődnek. Ha nincs megadva hozzáférés vagy tárolóAcl, a meglévő tároló ACL el lesz távolítva.

Ha tárolón hoz létre tárolt hozzáférési szabályzatot, az érvénybe lépése akár 30 másodpercet is igénybe vehet. Ebben az intervallumban a tárolt hozzáférési szabályzathoz társított közös hozzáférésű jogosultságkód a 403-as (Tiltott) állapotkóddal meghiúsul, amíg a hozzáférési szabályzat aktívvá nem válik.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-container-acl
setMetadata(Metadata, ContainerSetMetadataOptions)

Beállít egy vagy több felhasználó által definiált név-érték párot a megadott tárolóhoz.

Ha nincs megadva lehetőség, vagy nincs megadva metaadat a paraméterben, a tároló metaadatai el lesznek távolítva.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-container-metadata
uploadBlockBlob(string, RequestBodyType, number, BlockBlobUploadOptions)

Létrehoz egy új blokkblobot, vagy frissíti egy meglévő blokkblob tartalmát.

Egy meglévő blokkblob frissítése felülírja a blob meglévő metaadatait. A részleges frissítések nem támogatottak; a meglévő blob tartalma felülíródik az új tartalommal. A blokkblobok részleges frissítéséhez használja stageBlock és commitBlockList.

Ez egy nem párhuzamos feltöltési módszer, használja uploadFile, uploadStream vagy uploadBrowserData az egyidejűségi feltöltés jobb teljesítménye érdekében.

Lásd: https://learn.microsoft.com/rest/api/storageservices/put-blob

Konstruktor adatai

ContainerClient(string, PipelineLike)

Létrehozza a ContainerClient egy példányát. Ez a metódus egy tárolóra mutató URL-címet fogad el. A kódolt URL-sztring nem lesz kétszer feloldva, csak az URL-elérési út speciális karakterei lesznek feloldva. Ha egy blobnév tartalmaz? vagy %, a blob nevét az URL-címben kell kódolni.

new ContainerClient(url: string, pipeline: PipelineLike)

Paraméterek

url

string

Egy Azure Storage-tárolóra mutató URL-sztring, például "https://myaccount.blob.core.windows.net/mycontainer". Az SAS hozzáfűzhető, ha AnonymousCredentialt használ, például "https://myaccount.blob.core.windows.net/mycontainer?sasString".

pipeline
PipelineLike

A newPipeline() hívása egy alapértelmezett folyamat létrehozásához vagy egy testreszabott folyamat megadásához.

ContainerClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Létrehozza a ContainerClient egy példányát. Ez a metódus egy tárolóra mutató URL-címet fogad el. A kódolt URL-sztring nem lesz kétszer feloldva, csak az URL-elérési út speciális karakterei lesznek feloldva. Ha egy blobnév tartalmaz? vagy %, a blob nevét az URL-címben kell kódolni.

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

Paraméterek

url

string

Egy Azure Storage-tárolóra mutató URL-sztring, például "https://myaccount.blob.core.windows.net/mycontainer". Az SAS hozzáfűzhető, ha AnonymousCredentialt használ, például "https://myaccount.blob.core.windows.net/mycontainer?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a @azure/identity csomag bármely hitelesítő adata a szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential interfészt. Ha nincs megadva, az AnonymousCredential lesz használva.

options
StoragePipelineOptions

Optional. A HTTP-folyamat konfigurálására vonatkozó beállítások.

ContainerClient(string, string, StoragePipelineOptions)

Létrehozza a ContainerClient egy példányát.

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

Paraméterek

connectionString

string

Fiókkapcsolati sztring vagy egy Azure Storage-fiók SAS-kapcsolati sztringje. [ Megjegyzés – A fiókkapcsolati sztring csak NODE.JS futtatókörnyezetben használható. ] Példa fiókkapcsolati sztringre – DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS kapcsolati sztring példa – BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

containerName

string

Tároló neve.

options
StoragePipelineOptions

Optional. A HTTP-folyamat konfigurálására vonatkozó beállítások.

Tulajdonság adatai

containerName

A tároló neve.

string containerName

Tulajdonság értéke

string

Örökölt tulajdonság részletei

accountName 

accountName: string

Tulajdonság értéke

string

örökölt StorageClient.accountName

credential

Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a @azure/identity csomag bármely hitelesítő adata a szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential interfészt. Ha nincs megadva, az AnonymousCredential lesz használva.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tulajdonság értéke

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

örökölt StorageClient.credential

url

Kódolt URL-sztringérték.

url: string

Tulajdonság értéke

string

örökölt StorageClient.url-címről

Metódus adatai

create(ContainerCreateOptions)

Létrehoz egy új tárolót a megadott fiók alatt. Ha az azonos nevű tároló már létezik, a művelet meghiúsul.

Lásd https://learn.microsoft.com/rest/api/storageservices/create-container elnevezési szabályokat: Lásd: https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

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

Paraméterek

options
ContainerCreateOptions

A Tároló létrehozása művelet beállításai.

Példahasználat:

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

Válaszok

Promise<ContainerCreateResponse>

createIfNotExists(ContainerCreateOptions)

Létrehoz egy új tárolót a megadott fiók alatt. Ha az azonos nevű tároló már létezik, az nem módosul.

Lásd https://learn.microsoft.com/rest/api/storageservices/create-container elnevezési szabályokat: Lásd: https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

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

Paraméterek

options
ContainerCreateOptions

Válaszok

Promise<ContainerCreateIfNotExistsResponse>

delete(ContainerDeleteMethodOptions)

Megjelöli a megadott tárolót törlésre. A tároló és a benne található blobok később törlődnek a szemétgyűjtés során.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-container

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

Paraméterek

options
ContainerDeleteMethodOptions

Tárolótörlési művelet beállításai.

Válaszok

Promise<ContainerDeleteResponse>

deleteBlob(string, ContainerDeleteBlobOptions)

Megjelöli a megadott blobot vagy pillanatképet törlésre. A blob később törlődik a szemétgyűjtés során. Vegye figyelembe, hogy egy blob törléséhez törölnie kell az összes pillanatképét. A Blob törlése művelettel egyszerre mindkettő törölhető.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-blob

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

Paraméterek

blobName

string

options
ContainerDeleteBlobOptions

Blobtörlési művelet beállításai.

Válaszok

Promise<BlobDeleteResponse>

Blobtörlési válaszadatok letiltása.

deleteIfExists(ContainerDeleteMethodOptions)

Megjelöli a megadott tárolót törlésre, ha létezik. A tároló és a benne található blobok később törlődnek a szemétgyűjtés során.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-container

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

Paraméterek

options
ContainerDeleteMethodOptions

Tárolótörlési művelet beállításai.

Válaszok

Promise<ContainerDeleteIfExistsResponse>

exists(ContainerExistsOptions)

Igaz értéket ad vissza, ha az ügyfél által képviselt Azure-tárolóerőforrás létezik; máskülönben hamis.

MEGJEGYZÉS: Ezt a függvényt körültekintően használja, mivel előfordulhat, hogy egy meglévő tárolót más ügyfelek vagy alkalmazások törölnek. Fordítva, az azonos nevű új tárolókat más ügyfelek vagy alkalmazások is hozzáadhatják a függvény befejeződése után.

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

Paraméterek

options
ContainerExistsOptions

Válaszok

Promise<boolean>

findBlobsByTags(string, ContainerFindBlobByTagsOptions)

Egy aszinkron iterátorral adja vissza az összes blobot, amely a megadott címkével rendelkezik a megadott tároló alatt.

A .byPage() aszinkron iterátort ad vissza a lapok blobjainak listázásához.

Példa for await szintaxis használatára:

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>

Paraméterek

tagFilterSqlExpression

string

A where paraméter lehetővé teszi, hogy a hívó lekérdezhesse azokat a blobokat, amelyek címkéi megegyeznek egy adott kifejezéssel. A megadott kifejezésnek igaznak kell lennie ahhoz, hogy egy blob vissza legyen adva az eredményekben. A[OData – ABNF] szűrőszintaxis-szabály a lekérdezési paraméter értékének formális nyelvtanát határozza meg; A Blob szolgáltatás azonban csak az OData-szűrőszintaxis egy részhalmazát támogatja.

options
ContainerFindBlobByTagsOptions

A blobok címkék szerinti keresésének lehetőségei.

Válaszok

PagedAsyncIterableIterator<FilterBlobItem, ContainerFindBlobsByTagsSegmentResponse, PageSettings>

generateSasStringToSign(ContainerGenerateSasUrlOptions)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott ContainerClient esetén érhető el.

Sztringet hoz létre a Blob Container Service megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: ContainerGenerateSasUrlOptions): string

Paraméterek

options
ContainerGenerateSasUrlOptions

Nem kötelező paraméterek.

Válaszok

string

Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.

generateSasUrl(ContainerGenerateSasUrlOptions)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott ContainerClient esetén érhető el.

Létrehoz egy Blob Container Service Megosztott hozzáférésű jogosultságkód (SAS) URI-t a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

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

Paraméterek

options
ContainerGenerateSasUrlOptions

Nem kötelező paraméterek.

Válaszok

Promise<string>

Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.

generateUserDelegationSasStringToSign(ContainerGenerateSasUrlOptions, UserDelegationKey)

Sztringet hoz létre a Blob Container Service megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t a bemeneti felhasználó delegálási kulcsa írja alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

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

Paraméterek

options
ContainerGenerateSasUrlOptions

Nem kötelező paraméterek.

userDelegationKey
UserDelegationKey

A blobServiceClient.getUserDelegationKey() visszaadott értéke

Válaszok

string

Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.

generateUserDelegationSasUrl(ContainerGenerateSasUrlOptions, UserDelegationKey)

Létrehoz egy Blob Container Service Megosztott hozzáférésű jogosultságkód (SAS) URI-t a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t a bemeneti felhasználó delegálási kulcsa írja alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

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

Paraméterek

options
ContainerGenerateSasUrlOptions

Nem kötelező paraméterek.

userDelegationKey
UserDelegationKey

A blobServiceClient.getUserDelegationKey() visszaadott értéke

Válaszok

Promise<string>

Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.

getAccessPolicy(ContainerGetAccessPolicyOptions)

Lekéri a megadott tároló engedélyeit. Az engedélyek azt jelzik, hogy a tárolóadatok nyilvánosan elérhetők-e.

FIGYELMEZTETÉS: A JavaScript-dátum valószínűleg elveszíti a pontosságot a startsOn és a expiresOn sztringek elemzésekor. Például az új Date("2018-12-31T03:44:23.8827891Z").toISOString() a következőt kapja: "2018-12-31T03:44:23.882Z".

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-container-acl

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

Paraméterek

options
ContainerGetAccessPolicyOptions

A Container Get Access Policy művelet beállításai.

Válaszok

Promise<ContainerGetAccessPolicyResponse>

getAccountInfo(ContainerGetAccountInfoOptions)

A Fiókadatok lekérése művelet a megadott fiók termékváltozatának nevét és típusát adja vissza. A Fiókadatok lekérése művelet a 2018-03-28-es verziójú szolgáltatásverziókban érhető el.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-account-information

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

Paraméterek

options
ContainerGetAccountInfoOptions

A Szolgáltatás lekérése fiókinformációs művelet beállításai.

Válaszok

Promise<ContainerGetAccountInfoResponse>

A Szolgáltatás lekérése fiókinformációs művelet válaszadatai.

getAppendBlobClient(string)

Létrehoz egy AppendBlobClient

function getAppendBlobClient(blobName: string): AppendBlobClient

Paraméterek

blobName

string

Hozzáfűző blobnév

Válaszok

AppendBlobClient

getBlobBatchClient()

Létrehoz egy BlobBatchClient objektumot a kötegelt műveletek végrehajtásához.

Lásd: https://learn.microsoft.com/rest/api/storageservices/blob-batch

function getBlobBatchClient(): BlobBatchClient

Válaszok

BlobBatchClient

A tároló új BlobBatchClient objektuma.

getBlobClient(string)

BlobClient- létrehozása

function getBlobClient(blobName: string): BlobClient

Paraméterek

blobName

string

Blobnév

Válaszok

BlobClient

Egy új BlobClient-objektum a megadott blobnévhez.

getBlobLeaseClient(string)

Szerezzen be egy BlobLeaseClient, amely a tárolón lévő bérleteket kezeli.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Paraméterek

proposeLeaseId

string

Kezdeti javasolt bérletazonosító.

Válaszok

BlobLeaseClient

Új BlobLeaseClient objektum a tároló bérleteinek kezeléséhez.

getBlockBlobClient(string)

Létrehoz egy BlockBlobClient

function getBlockBlobClient(blobName: string): BlockBlobClient

Paraméterek

blobName

string

Blokkblob neve

Példahasználat:

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

Válaszok

BlockBlobClient

getPageBlobClient(string)

Létrehoz egy PageBlobClient

function getPageBlobClient(blobName: string): PageBlobClient

Paraméterek

blobName

string

Lapblob neve

Válaszok

PageBlobClient

getProperties(ContainerGetPropertiesOptions)

A megadott tároló felhasználó által definiált metaadatait és rendszertulajdonságait adja vissza. A visszaadott adatok nem tartalmazzák a tároló bloblistáját.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-container-properties

FIGYELMEZTETÉS: A válaszban visszaadott metadata objektumnak kisbetűs kulcsai lesznek, még akkor is, ha eredetileg nagybetűket tartalmaztak. Ez eltér a BlobServiceClient metódusa által visszaadott metaadatkulcsoktól a beállítással, amely megőrzi az eredeti burkolatot.

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

Paraméterek

options
ContainerGetPropertiesOptions

A Container Get Properties művelet beállításai.

Válaszok

Promise<ContainerGetPropertiesResponse>

listBlobsByHierarchy(string, ContainerListBlobsOptions)

Egy aszinkron iterátort ad vissza az összes blob hierarchia szerinti listázásához. a megadott fiók alatt.

A .byPage() egy aszinkron iterátorral listázhatja a blobokat a lapok hierarchiája szerint.

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>

Paraméterek

delimiter

string

A virtuális hierarchia definiálásához használt karakter vagy sztring

options
ContainerListBlobsOptions

A blobok listájának beállításai.

Válaszok

PagedAsyncIterableIterator<({ kind: "prefix" } & BlobPrefix) | ({ kind: "blob" } & BlobItem), ContainerListBlobHierarchySegmentResponse, PageSettings>

listBlobsFlat(ContainerListBlobsOptions)

Egy aszinkron iterátort ad vissza, amely felsorolja a megadott fiókban lévő összes blobot.

A .byPage() aszinkron iterátort ad vissza a lapok blobjainak listázásához.

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>

Paraméterek

options
ContainerListBlobsOptions

A blobok listázásának beállításai.

Válaszok

PagedAsyncIterableIterator<BlobItem, ContainerListBlobFlatSegmentResponse, PageSettings>

Lapozást támogató asyncIterableIterator.

setAccessPolicy(PublicAccessType, SignedIdentifier[], ContainerSetAccessPolicyOptions)

Beállítja a megadott tároló engedélyeit. Az engedélyek azt jelzik, hogy a tárolóban lévő blobok nyilvánosan elérhetők-e.

Egy tároló engedélyeinek beállításakor a meglévő engedélyek lecserélődnek. Ha nincs megadva hozzáférés vagy tárolóAcl, a meglévő tároló ACL el lesz távolítva.

Ha tárolón hoz létre tárolt hozzáférési szabályzatot, az érvénybe lépése akár 30 másodpercet is igénybe vehet. Ebben az intervallumban a tárolt hozzáférési szabályzathoz társított közös hozzáférésű jogosultságkód a 403-as (Tiltott) állapotkóddal meghiúsul, amíg a hozzáférési szabályzat aktívvá nem válik.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-container-acl

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

Paraméterek

access
PublicAccessType

A tárolóban lévő adatokhoz való nyilvános hozzáférés szintje.

containerAcl

SignedIdentifier[]

Egyedi azonosítóval és a hozzáférési szabályzat részleteivel rendelkező elemek tömbje.

options
ContainerSetAccessPolicyOptions

A Tárolókészlet hozzáférési szabályzat műveletének beállításai.

Válaszok

Promise<ContainerSetAccessPolicyResponse>

setMetadata(Metadata, ContainerSetMetadataOptions)

Beállít egy vagy több felhasználó által definiált név-érték párot a megadott tárolóhoz.

Ha nincs megadva lehetőség, vagy nincs megadva metaadat a paraméterben, a tároló metaadatai el lesznek távolítva.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-container-metadata

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

Paraméterek

metadata
Metadata

Cserélje le a meglévő metaadatokat erre az értékre. Ha nincs megadva érték, a meglévő metaadatok el lesznek távolítva.

options
ContainerSetMetadataOptions

A Tárolókészlet metaadatok műveletének beállításai.

Válaszok

Promise<ContainerSetMetadataResponse>

uploadBlockBlob(string, RequestBodyType, number, BlockBlobUploadOptions)

Létrehoz egy új blokkblobot, vagy frissíti egy meglévő blokkblob tartalmát.

Egy meglévő blokkblob frissítése felülírja a blob meglévő metaadatait. A részleges frissítések nem támogatottak; a meglévő blob tartalma felülíródik az új tartalommal. A blokkblobok részleges frissítéséhez használja stageBlock és commitBlockList.

Ez egy nem párhuzamos feltöltési módszer, használja uploadFile, uploadStream vagy uploadBrowserData az egyidejűségi feltöltés jobb teljesítménye érdekében.

Lásd: https://learn.microsoft.com/rest/api/storageservices/put-blob

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

Paraméterek

blobName

string

A létrehozni vagy frissíteni kívánt blokkblob neve.

body
HttpRequestBody

Blob, sztring, ArrayBuffer, ArrayBufferView vagy olyan függvény, amely egy új olvasható adatfolyamot ad vissza, amelynek eltolása az adatforrás kezdetétől származik.

contentLength

number

A törzs hossza bájtban. A Buffer.byteLength() használatával kiszámíthatja egy sztring törzshosszát, beleértve a nem Base64/Hex kódolású karaktereket is.

options
BlockBlobUploadOptions

A Blobfeltöltés blokkolása művelet konfigurálására szolgáló beállítások.

Válaszok

Promise<{ blockBlobClient: BlockBlobClient, response: BlockBlobUploadResponse }>

Blobfeltöltési válaszadatok és a megfelelő BlockBlobClient-példány blokkolása.