ContainerClient class
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
Container |
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 tartalmazza a következőt: ? vagy %, a blob nevét az URL-címben kell kódolni. |
Container |
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 tartalmazza a következőt: ? vagy %, a blob nevét az URL-címben kell kódolni. |
Container |
Létrehoz egy ContainerClient-példányt. |
Tulajdonságok
container |
A tároló neve. |
Örökölt tulajdonságok
account |
|
credential | Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a csomag bármely hitelesítő adata a |
url | Kódolt URL-sztringérték. |
Metódusok
create(Container |
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://docs.microsoft.com/en-us/rest/api/storageservices/create-container Elnevezési szabályok: Lásd: https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata |
create |
Létrehoz egy új tárolót a megadott fiók alatt. Ha az azonos nevű tároló már létezik, a rendszer nem módosítja. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/create-container Elnevezési szabályok: Lásd: https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata |
delete(Container |
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://docs.microsoft.com/en-us/rest/api/storageservices/delete-container |
delete |
Megjelöli a megadott blobot vagy pillanatképet a törléshez. 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. Mindkettőt egyszerre törölheti a Blob törlése művelettel. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob |
delete |
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://docs.microsoft.com/en-us/rest/api/storageservices/delete-container |
exists(Container |
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, előfordulhat, hogy a függvény befejeződése után más ügyfelek vagy alkalmazások új, azonos nevű tárolókat adnak hozzá. |
find |
Egy aszinkron iterátorral adja vissza az összes olyan blobot, amely a megadott címkével rendelkezik a megadott tároló alatt. A .byPage() egy aszinkron iterátorral listázhatja a blobokat a lapokban. Példa szintaxis használatával
Példa a következő használatával
Példa a következő használatával
Példa jelölővel ellátott lapozásra:
|
generate |
Csak megosztott kulcsú hitelesítő adatokkal létrehozott ContainerClienthez é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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas |
get |
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 Dátum("2018-12-31T03:44:23.8827891Z").toISOString() a következőt kapja: "2018-12-31T03:44:23.882Z". Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl |
get |
AppendBlobClient létrehozása |
get |
Létrehoz egy BlobBatchClient objektumot a kötegelt műveletek végrehajtásához. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch |
get |
BlobClient létrehozása |
get |
Szerezzen be egy BlobLeaseClientet , amely a tárolón lévő bérleteket kezeli. |
get |
BlockBlobClient létrehozása |
get |
PageBlobClient létrehozása |
get |
A felhasználó által definiált metaadatokat és rendszertulajdonságokat adja vissza a megadott tárolóhoz. A visszaadott adatok nem tartalmazzák a tároló bloblistáját. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties FIGYELMEZTETÉS: A |
list |
Egy aszinkron iterátorral listázhatja az összes blobot hierarchia szerint. a megadott fiók alatt. A .byPage() egy aszinkron iterátorral listázhatja a blobokat hierarchia szerint a lapokban. Példa szintaxis használatával
Példa a következő használatával
Példa a következő használatával
Példa lapozásra maximális oldalmérettel:
|
list |
Egy aszinkron iterálót ad vissza a megadott fiókban található összes blob listázásához. A .byPage() egy aszinkron iterátorral listázhatja a blobokat a lapokban. Példa szintaxis használatával
Példa a használatával
Példa a használatával
Példa jelölővel ellátott lapozásra:
|
set |
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. Amikor engedélyeket állít be egy tárolóhoz, a rendszer lecseréli a meglévő engedélyeket. Ha nincs megadva hozzáférés vagy containerAcl, 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, akár 30 másodpercig is eltarthat a érvénybe lépése. Ebben az időszakban 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://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl |
set |
Beállít egy vagy több felhasználó által definiált név-érték párt 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://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata |
upload |
Új blokkblobot hoz létre, 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 a stageBlock és a commitBlockList parancsot. Ez egy nem párhuzamos feltöltési módszer. Az egyidejű feltöltés jobb teljesítménye érdekében használja az uploadFile, uploadStream vagy uploadBrowserData metódust. Lásd: https://docs.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 tartalmazza a következőt: ? 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". Sas hozzáfűzhető, ha AnonymousCredential (pl. "https://myaccount.blob.core.windows.net/mycontainer?sasString") használatával használja.
- pipeline
- PipelineLike
Hívja meg a newPipeline() metódust egy alapértelmezett folyamat létrehozásához, vagy adjon meg egy testre szabott folyamatot.
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 tartalmazza a következőt: ? 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". 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 csomag bármely hitelesítő adata a @azure/identity
szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential felületet. Ha nincs megadva, az AnonymousCredential lesz használva.
- options
- StoragePipelineOptions
Választható. A HTTP-folyamat konfigurálásának beállításai.
ContainerClient(string, string, StoragePipelineOptions)
Létrehoz egy ContainerClient-példányt.
new ContainerClient(connectionString: string, containerName: string, options?: StoragePipelineOptions)
Paraméterek
- connectionString
-
string
Azure Storage-fiók fiók kapcsolati sztring vagy SAS-kapcsolati sztring.
[ Megjegyzés – A fiók kapcsolati sztring csak NODE.JS futtatókörnyezetben használható. ] Fiók kapcsolati sztring példa –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
Választható. A HTTP-folyamat konfigurálásának beállításai.
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 forrás StorageClient.accountName
credential
Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a csomag bármely hitelesítő adata a @azure/identity
szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential felületet. Ha nincs megadva, az AnonymousCredential lesz használva.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Tulajdonság értéke
Örökölt forrás StorageClient.credential
url
Kódolt URL-sztringérték.
url: string
Tulajdonság értéke
string
Örökölt forrás StorageClient.url
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://docs.microsoft.com/en-us/rest/api/storageservices/create-container Elnevezési szabályok: 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:
const containerClient = blobServiceClient.getContainerClient("<container name>");
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, a rendszer nem módosítja.
Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/create-container Elnevezési szabályok: 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://docs.microsoft.com/en-us/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 a törléshez. 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. Mindkettőt egyszerre törölheti a Blob törlése művelettel.
Lásd: https://docs.microsoft.com/en-us/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://docs.microsoft.com/en-us/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, előfordulhat, hogy a függvény befejeződése után más ügyfelek vagy alkalmazások új, azonos nevű tárolókat adnak hozzá.
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 olyan blobot, amely a megadott címkével rendelkezik a megadott tároló alatt.
A .byPage() egy aszinkron iterátorral listázhatja a blobokat a lapokban.
Példa szintaxis használatával for await
:
let i = 1;
for await (const blob of containerClient.findBlobsByTags("tagkey='tagvalue'")) {
console.log(`Blob ${i++}: ${blob.name}`);
}
Példa a következő használatával 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();
}
Példa a következő használatával 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}`);
}
}
}
Példa jelölővel ellátott lapozásra:
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>
Paraméterek
- tagFilterSqlExpression
-
string
A where paraméterrel a hívó lekérdezheti azokat a blobokat, amelyek címkéi megegyeznek egy adott kifejezéssel. Az adott kifejezésnek igaz értékre kell kiértékelnie, hogy egy blob vissza legyen adva az eredményekben. A[OData – ABNF] szűrőszintaxis-szabály a where lekérdezési paraméter értékének formális nyelvhelyességi értéké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 megkeresésének lehetőségei.
Válaszok
generateSasUrl(ContainerGenerateSasUrlOptions)
Csak megosztott kulcsú hitelesítő adatokkal létrehozott ContainerClienthez é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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: ContainerGenerateSasUrlOptions): Promise<string>
Paraméterek
- options
- ContainerGenerateSasUrlOptions
Választható 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.
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 Dátum("2018-12-31T03:44:23.8827891Z").toISOString() a következőt kapja: "2018-12-31T03:44:23.882Z".
Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl
function getAccessPolicy(options?: ContainerGetAccessPolicyOptions): Promise<ContainerGetAccessPolicyResponse>
Paraméterek
- options
- ContainerGetAccessPolicyOptions
A Tároló hozzáférési szabályzatának lekérése művelet beállításai.
Válaszok
Promise<ContainerGetAccessPolicyResponse>
getAppendBlobClient(string)
AppendBlobClient létrehozása
function getAppendBlobClient(blobName: string): AppendBlobClient
Paraméterek
- blobName
-
string
Hozzáfűző blobnév
Válaszok
getBlobBatchClient()
Létrehoz egy BlobBatchClient objektumot a kötegelt műveletek végrehajtásához.
Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
function getBlobBatchClient(): BlobBatchClient
Válaszok
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
Egy új BlobClient objektum a megadott blobnévhez.
getBlobLeaseClient(string)
Szerezzen be egy BlobLeaseClientet , 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
Egy új BlobLeaseClient objektum a tároló bérleteinek kezeléséhez.
getBlockBlobClient(string)
BlockBlobClient létrehozása
function getBlockBlobClient(blobName: string): BlockBlobClient
Paraméterek
- blobName
-
string
Blokkblob neve
Példahasználat:
const content = "Hello world!";
const blockBlobClient = containerClient.getBlockBlobClient("<blob name>");
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);
Válaszok
getPageBlobClient(string)
PageBlobClient létrehozása
function getPageBlobClient(blobName: string): PageBlobClient
Paraméterek
- blobName
-
string
Lapblob neve
Válaszok
getProperties(ContainerGetPropertiesOptions)
A felhasználó által definiált metaadatokat és rendszertulajdonságokat adja vissza a megadott tárolóhoz. A visszaadott adatok nem tartalmazzák a tároló bloblistáját.
Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties
FIGYELMEZTETÉS: A metadata
válaszban visszaadott objektumnak kisbetűs kulcsai lesznek, még akkor is, ha eredetileg nagybetűket tartalmaztak. Ez eltér a BlobServiceClient metódus által listContainers
visszaadott metaadatkulcsoktól a beállítással, amely megőrzi az includeMetadata
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átorral listázhatja az összes blobot hierarchia szerint. a megadott fiók alatt.
A .byPage() egy aszinkron iterátorral listázhatja a blobokat hierarchia szerint a lapokban.
Példa szintaxis használatával 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}`);
}
}
Példa a következő használatával 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();
}
Példa a következő használatával 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}`);
}
}
Példa lapozásra maximális oldalmérettel:
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>
Paraméterek
- delimiter
-
string
A virtuális hierarchia definiálásához használt karakter vagy sztring
- options
- ContainerListBlobsOptions
A blobművelet listázásának beállításai.
Válaszok
PagedAsyncIterableIterator<({ kind: "prefix" } & BlobPrefix) | ({ kind: "blob" } & BlobItem), ContainerListBlobHierarchySegmentResponse, PageSettings>
listBlobsFlat(ContainerListBlobsOptions)
Egy aszinkron iterálót ad vissza a megadott fiókban található összes blob listázásához.
A .byPage() egy aszinkron iterátorral listázhatja a blobokat a lapokban.
Példa szintaxis használatával 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}`);
}
Példa a használatával 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();
}
Példa a használatával 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}`);
}
}
Példa jelölővel ellátott lapozásra:
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>
Paraméterek
- options
- ContainerListBlobsOptions
Blobok listázásának beállításai.
Válaszok
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.
Amikor engedélyeket állít be egy tárolóhoz, a rendszer lecseréli a meglévő engedélyeket. Ha nincs megadva hozzáférés vagy containerAcl, 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, akár 30 másodpercig is eltarthat a érvénybe lépése. Ebben az időszakban 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://docs.microsoft.com/en-us/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
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árt 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://docs.microsoft.com/en-us/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 metaadatai művelet beállításai.
Válaszok
Promise<ContainerSetMetadataResponse>
uploadBlockBlob(string, RequestBodyType, number, BlockBlobUploadOptions)
Új blokkblobot hoz létre, 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 a stageBlock és a commitBlockList parancsot.
Ez egy nem párhuzamos feltöltési módszer. Az egyidejű feltöltés jobb teljesítménye érdekében használja az uploadFile, uploadStream vagy uploadBrowserData metódust.
Lásd: https://docs.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 elejéről származik.
- contentLength
-
number
A törzs hossza bájtban. Használja a Buffer.byteLength() függvényt egy sztring törzshosszának kiszámításához, beleértve a nem Base64/Hex kódolású karaktereket is.
- options
- BlockBlobUploadOptions
A Blokkblob feltöltése művelet konfigurálásának beállításai.
Válaszok
Promise<{ blockBlobClient: BlockBlobClient, response: BlockBlobUploadResponse }>
A blokkblob feltölti a válaszadatokat és a megfelelő BlockBlobClient-példányt.