Sdílet prostřednictvím

ContainerClient class

  • Reference
Balíček:
@azure/storage-blob

ContainerClient představuje adresu URL kontejneru Azure Storage, který umožňuje manipulovat s jeho objekty blob.

Extends

StorageClient

Konstruktory

ContainerClient(string, PipelineLike)

Vytvoří instanci ContainerClient. Tato metoda přijímá adresu URL odkazující na kontejner. Kódovaný řetězec adresy URL nebude uchvácen dvakrát, pouze speciální znaky v cestě URL budou uchvácené. Pokud název objektu blob obsahuje? nebo %, název objektu blob musí být kódován v adrese URL.
ContainerClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Vytvoří instanci ContainerClient. Tato metoda přijímá adresu URL odkazující na kontejner. Kódovaný řetězec adresy URL nebude uchvácen dvakrát, pouze speciální znaky v cestě URL budou uchvácené. Pokud název objektu blob obsahuje? nebo %, název objektu blob musí být kódován v adrese URL.
ContainerClient(string, string, StoragePipelineOptions)

Vytvoří instanci ContainerClient.

Vlastnosti

containerName

Název kontejneru.

Zděděné vlastnosti

accountName
credential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z balíčku @azure/identity k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. Pokud není zadáno, použije se anonymnícredential.
url

Zakódovaná hodnota řetězce adresy URL.

Metody

create(ContainerCreateOptions)

Vytvoří nový kontejner pod zadaným účtem. Pokud kontejner se stejným názvem již existuje, operace selže.

Viz pravidla pojmenování https://docs.microsoft.com/en-us/rest/api/storageservices/create-container: Viz https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
createIfNotExists(ContainerCreateOptions)

Vytvoří nový kontejner pod zadaným účtem. Pokud kontejner se stejným názvem již existuje, nezmění se.

Viz pravidla pojmenování https://docs.microsoft.com/en-us/rest/api/storageservices/create-container: Viz https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
delete(ContainerDeleteMethodOptions)

Označí zadaný kontejner pro odstranění. Kontejner a všechny objekty blob obsažené v něm se později odstraní během uvolňování paměti.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container
deleteBlob(string, ContainerDeleteBlobOptions)

Označí zadaný objekt blob nebo snímek pro odstranění. Objekt blob se později odstraní během uvolňování paměti. Nezapomeňte, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně s operací Odstranit objekt blob.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteIfExists(ContainerDeleteMethodOptions)

Označí zadaný kontejner pro odstranění, pokud existuje. Kontejner a všechny objekty blob obsažené v něm se později odstraní během uvolňování paměti.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container
exists(ContainerExistsOptions)

Vrátí hodnotu true, pokud prostředek kontejneru Azure reprezentovaný tímto klientem existuje. jinak nepravda.

POZNÁMKA: Tuto funkci používejte opatrně, protože existující kontejner může být odstraněn jinými klienty nebo aplikacemi. Po dokončení této funkce mohou být nové kontejnery se stejným názvem přidány jinými klienty nebo aplikacemi.
findBlobsByTags(string, ContainerFindBlobByTagsOptions)

Vrátí asynchronní iterátor pro vyhledání všech objektů blob se zadanou značkou v zadaném kontejneru.

.byPage() vrátí asynchronní iterátor pro výpis objektů blob na stránkách.

Příklad použití syntaxe for await:

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

Příklad použití 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říklad použití 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říklad použití stránkování se značkou:

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

K dispozici pouze pro ContainerClient vytvořené pomocí přihlašovacích údajů sdíleného klíče.

Vygeneruje identifikátor URI sdíleného přístupového podpisu služby Blob Container Service (SAS) na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(ContainerGetAccessPolicyOptions)

Získá oprávnění pro zadaný kontejner. Oprávnění označují, jestli je možné přistupovat k datům kontejneru veřejně.

UPOZORNĚNÍ: JavaScript Date může přijít o přesnost při analýze startOn a vypršení platnosti řetězcůOn. Například nové datum("2018-12-31T03:44:23.8827891Z"). toISOString() získá "2018-12-31T03:44:23.882Z".

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl
getAccountInfo(ContainerGetAccountInfoOptions)

Operace Získat informace o účtu vrátí název skladové položky a druh účtu pro zadaný účet. Operace Získat informace o účtu je k dispozici ve verzích služby od verze 2018-03-28.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
getAppendBlobClient(string)

Vytvoří AppendBlobClient.
getBlobBatchClient()

Vytvoří objekt BlobBatchClient pro provádění dávkových operací.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
getBlobClient(string)

Vytvoří BlobClient.
getBlobLeaseClient(string)

Získejte BlobLeaseClient, který spravuje zapůjčení kontejneru.
getBlockBlobClient(string)

Vytvoří BlockBlobClient.
getPageBlobClient(string)

Vytvoří PageBlobClient.
getProperties(ContainerGetPropertiesOptions)

Vrátí všechna uživatelsky definovaná metadata a systémové vlastnosti zadaného kontejneru. Vrácená data nezahrnují seznam objektů blob kontejneru.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties

UPOZORNĚNÍ: Objekt metadata vrácený v odpovědi bude mít klíče malými písmeny, i když původně obsahovaly velké znaky. To se liší od klíčů metadat vrácených listContainers metodou BlobServiceClient pomocí možnosti includeMetadata, která zachová původní velikost velikosti.
listBlobsByHierarchy(string, ContainerListBlobsOptions)

Vrátí asynchronní iterátor pro výpis všech objektů blob podle hierarchie. pod zadaným účtem.

.byPage() vrátí asynchronní iterátor pro výpis objektů blob podle hierarchie na stránkách.

Příklad použití syntaxe 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říklad použití 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říklad použití 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říklad použití stránkování s maximální velikostí stránky:

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

Vrátí asynchronní iterátor, který zobrazí seznam všech objektů blob v zadaném účtu.

.byPage() vrátí asynchronní iterátor pro výpis objektů blob na stránkách.

Příklad použití syntaxe 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říklad použití 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říklad použití 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říklad použití stránkování se značkou:

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

Nastaví oprávnění pro zadaný kontejner. Oprávnění označují, jestli se k objektům blob v kontejneru může přistupovat veřejně.

Když nastavíte oprávnění pro kontejner, nahradí se stávající oprávnění. Pokud není k dispozici žádný přístup nebo seznam ContainerAcl, odebere se stávající seznam ACL kontejneru.

Když vytvoříte uložené zásady přístupu v kontejneru, může trvat až 30 sekund, než se projeví. Během tohoto intervalu sdílený přístupový podpis přidružený k uloženým zásadám přístupu selže se stavovým kódem 403 (Zakázáno), dokud zásady přístupu nebudou aktivní.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl
setMetadata(Metadata, ContainerSetMetadataOptions)

Nastaví jeden nebo více uživatelsky definovaných párů name-value pro zadaný kontejner.

Pokud není k dispozici žádná možnost nebo v parametru nejsou definována žádná metadata, metadata kontejneru se odeberou.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata
uploadBlockBlob(string, RequestBodyType, number, BlockBlobUploadOptions)

Vytvoří nový objekt blob bloku nebo aktualizuje obsah existujícího objektu blob bloku.

Aktualizace existujícího objektu blob bloku přepíše všechna existující metadata objektu blob. Částečné aktualizace nejsou podporovány; obsah existujícího objektu blob se přepíše novým obsahem. Pokud chcete provést částečnou aktualizaci objektu blob bloku, použijte stageBlock a commitBlockList.

Jedná se o metodu ne paralelního nahrávání, použijte uploadFile, uploadStream nebo uploadBrowserData pro lepší výkon při nahrávání souběžnosti.

Viz https://docs.microsoft.com/rest/api/storageservices/put-blob

Podrobnosti konstruktoru

ContainerClient(string, PipelineLike)

Vytvoří instanci ContainerClient. Tato metoda přijímá adresu URL odkazující na kontejner. Kódovaný řetězec adresy URL nebude uchvácen dvakrát, pouze speciální znaky v cestě URL budou uchvácené. Pokud název objektu blob obsahuje? nebo %, název objektu blob musí být kódován v adrese URL.

new ContainerClient(url: string, pipeline: PipelineLike)

Parametry

url

string

Řetězec adresy URL odkazující na kontejner Azure Storage, například "https://myaccount.blob.core.windows.net/mycontainer". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.blob.core.windows.net/mycontainer?sasString".

pipeline
PipelineLike

Voláním metody newPipeline() vytvořte výchozí kanál nebo zadejte přizpůsobený kanál.

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

Vytvoří instanci ContainerClient. Tato metoda přijímá adresu URL odkazující na kontejner. Kódovaný řetězec adresy URL nebude uchvácen dvakrát, pouze speciální znaky v cestě URL budou uchvácené. Pokud název objektu blob obsahuje? nebo %, název objektu blob musí být kódován v adrese URL.

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

Parametry

url

string

Řetězec adresy URL odkazující na kontejner Azure Storage, například "https://myaccount.blob.core.windows.net/mycontainer". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.blob.core.windows.net/mycontainer?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z balíčku @azure/identity k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. Pokud není zadáno, použije se anonymnícredential.

options
StoragePipelineOptions

Volitelný. Možnosti konfigurace kanálu HTTP

ContainerClient(string, string, StoragePipelineOptions)

Vytvoří instanci ContainerClient.

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

Parametry

connectionString

string

Připojovací řetězec účtu nebo připojovací řetězec SAS účtu úložiště Azure. [ Poznámka: Připojovací řetězec účtu lze použít pouze v NODE.JS modulu runtime. ] Příklad připojovacího řetězce účtu – Příklad připojovacího řetězce SAS DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net – 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

Název kontejneru.

options
StoragePipelineOptions

Volitelný. Možnosti konfigurace kanálu HTTP

Podrobnosti vlastnosti

containerName

Název kontejneru.

string containerName

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

accountName 

accountName: string

Hodnota vlastnosti

string

zděděno ze StorageClient.accountName

credential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z balíčku @azure/identity k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. Pokud není zadáno, použije se anonymnícredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Hodnota vlastnosti

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

zděděné z StorageClient.credential

url

Zakódovaná hodnota řetězce adresy URL.

url: string

Hodnota vlastnosti

string

zděděno ze StorageClient.url

Podrobnosti metody

create(ContainerCreateOptions)

Vytvoří nový kontejner pod zadaným účtem. Pokud kontejner se stejným názvem již existuje, operace selže.

Viz pravidla pojmenování https://docs.microsoft.com/en-us/rest/api/storageservices/create-container: Viz https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

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

Parametry

options
ContainerCreateOptions

Možnosti operace vytvoření kontejneru

Příklad použití:

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

Návraty

Promise<ContainerCreateResponse>

createIfNotExists(ContainerCreateOptions)

Vytvoří nový kontejner pod zadaným účtem. Pokud kontejner se stejným názvem již existuje, nezmění se.

Viz pravidla pojmenování https://docs.microsoft.com/en-us/rest/api/storageservices/create-container: Viz https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

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

Parametry

options
ContainerCreateOptions

Návraty

Promise<ContainerCreateIfNotExistsResponse>

delete(ContainerDeleteMethodOptions)

Označí zadaný kontejner pro odstranění. Kontejner a všechny objekty blob obsažené v něm se později odstraní během uvolňování paměti.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container

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

Parametry

options
ContainerDeleteMethodOptions

Možnosti operace odstranění kontejneru

Návraty

Promise<ContainerDeleteResponse>

deleteBlob(string, ContainerDeleteBlobOptions)

Označí zadaný objekt blob nebo snímek pro odstranění. Objekt blob se později odstraní během uvolňování paměti. Nezapomeňte, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně s operací Odstranit objekt blob.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

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

Parametry

blobName

string

options
ContainerDeleteBlobOptions

Možnosti operace odstranění objektu blob

Návraty

Promise<BlobDeleteResponse>

Data odpovědi na odstranění objektu blob bloku

deleteIfExists(ContainerDeleteMethodOptions)

Označí zadaný kontejner pro odstranění, pokud existuje. Kontejner a všechny objekty blob obsažené v něm se později odstraní během uvolňování paměti.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container

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

Parametry

options
ContainerDeleteMethodOptions

Možnosti operace odstranění kontejneru

Návraty

Promise<ContainerDeleteIfExistsResponse>

exists(ContainerExistsOptions)

Vrátí hodnotu true, pokud prostředek kontejneru Azure reprezentovaný tímto klientem existuje. jinak nepravda.

POZNÁMKA: Tuto funkci používejte opatrně, protože existující kontejner může být odstraněn jinými klienty nebo aplikacemi. Po dokončení této funkce mohou být nové kontejnery se stejným názvem přidány jinými klienty nebo aplikacemi.

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

Parametry

options
ContainerExistsOptions

Návraty

Promise<boolean>

findBlobsByTags(string, ContainerFindBlobByTagsOptions)

Vrátí asynchronní iterátor pro vyhledání všech objektů blob se zadanou značkou v zadaném kontejneru.

.byPage() vrátí asynchronní iterátor pro výpis objektů blob na stránkách.

Příklad použití syntaxe for await:

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

Příklad použití 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říklad použití 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říklad použití stránkování se značkou:

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>

Parametry

tagFilterSqlExpression

string

Parametr where volajícímu umožňuje dotazovat se na objekty blob, jejichž značky odpovídají danému výrazu. Daný výraz musí být vyhodnocen jako true, aby se objekt blob vrátil ve výsledcích. Pravidlo syntaxe filtru [OData - ABNF] definuje formální gramatiku pro hodnotu parametru dotazu where; Ale pouze podmnožina syntaxe filtru OData je podporována ve službě Blob Service.

options
ContainerFindBlobByTagsOptions

Možnosti vyhledání objektů blob podle značek

Návraty

PagedAsyncIterableIterator<FilterBlobItem, ContainerFindBlobsByTagsSegmentResponse, PageSettings>

generateSasUrl(ContainerGenerateSasUrlOptions)

K dispozici pouze pro ContainerClient vytvořené pomocí přihlašovacích údajů sdíleného klíče.

Vygeneruje identifikátor URI sdíleného přístupového podpisu služby Blob Container Service (SAS) na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

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

Parametry

options
ContainerGenerateSasUrlOptions

Volitelné parametry.

Návraty

Promise<string>

Identifikátor URI SAS, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.

getAccessPolicy(ContainerGetAccessPolicyOptions)

Získá oprávnění pro zadaný kontejner. Oprávnění označují, jestli je možné přistupovat k datům kontejneru veřejně.

UPOZORNĚNÍ: JavaScript Date může přijít o přesnost při analýze startOn a vypršení platnosti řetězcůOn. Například nové datum("2018-12-31T03:44:23.8827891Z"). toISOString() získá "2018-12-31T03:44:23.882Z".

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl

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

Parametry

options
ContainerGetAccessPolicyOptions

Možnosti operace zásad přístupu pro získání kontejneru

Návraty

Promise<ContainerGetAccessPolicyResponse>

getAccountInfo(ContainerGetAccountInfoOptions)

Operace Získat informace o účtu vrátí název skladové položky a druh účtu pro zadaný účet. Operace Získat informace o účtu je k dispozici ve verzích služby od verze 2018-03-28.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information

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

Parametry

options
ContainerGetAccountInfoOptions

Možnosti operace Získání informací o účtu služby

Návraty

Promise<ContainerGetAccountInfoResponse>

Data odpovědí pro operaci Získání informací o účtu služby

getAppendBlobClient(string)

Vytvoří AppendBlobClient.

function getAppendBlobClient(blobName: string): AppendBlobClient

Parametry

blobName

string

Název doplňovacího objektu blob

Návraty

AppendBlobClient

getBlobBatchClient()

Vytvoří objekt BlobBatchClient pro provádění dávkových operací.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch

function getBlobBatchClient(): BlobBatchClient

Návraty

BlobBatchClient

Nový objekt BlobBatchClient pro tento kontejner.

getBlobClient(string)

Vytvoří BlobClient.

function getBlobClient(blobName: string): BlobClient

Parametry

blobName

string

Název objektu blob

Návraty

BlobClient

Nový objekt BlobClient pro daný název objektu blob.

getBlobLeaseClient(string)

Získejte BlobLeaseClient, který spravuje zapůjčení kontejneru.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parametry

proposeLeaseId

string

Počáteční navrhované ID zapůjčení

Návraty

BlobLeaseClient

Nový objekt BlobLeaseClient pro správu zapůjčení v kontejneru.

getBlockBlobClient(string)

Vytvoří BlockBlobClient.

function getBlockBlobClient(blobName: string): BlockBlobClient

Parametry

blobName

string

Název objektu blob bloku

Příklad použití:

const content = "Hello world!";

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

Návraty

BlockBlobClient

getPageBlobClient(string)

Vytvoří PageBlobClient.

function getPageBlobClient(blobName: string): PageBlobClient

Parametry

blobName

string

Název objektu blob stránky

Návraty

PageBlobClient

getProperties(ContainerGetPropertiesOptions)

Vrátí všechna uživatelsky definovaná metadata a systémové vlastnosti zadaného kontejneru. Vrácená data nezahrnují seznam objektů blob kontejneru.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties

UPOZORNĚNÍ: Objekt metadata vrácený v odpovědi bude mít klíče malými písmeny, i když původně obsahovaly velké znaky. To se liší od klíčů metadat vrácených listContainers metodou BlobServiceClient pomocí možnosti includeMetadata, která zachová původní velikost velikosti.

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

Parametry

options
ContainerGetPropertiesOptions

Možnosti operace získání vlastností kontejneru

Návraty

Promise<ContainerGetPropertiesResponse>

listBlobsByHierarchy(string, ContainerListBlobsOptions)

Vrátí asynchronní iterátor pro výpis všech objektů blob podle hierarchie. pod zadaným účtem.

.byPage() vrátí asynchronní iterátor pro výpis objektů blob podle hierarchie na stránkách.

Příklad použití syntaxe 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říklad použití 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říklad použití 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říklad použití stránkování s maximální velikostí stránky:

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>

Parametry

delimiter

string

Znak nebo řetězec použitý k definování virtuální hierarchie

options
ContainerListBlobsOptions

Možnosti operace výpisu objektů blob

Návraty

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

listBlobsFlat(ContainerListBlobsOptions)

Vrátí asynchronní iterátor, který zobrazí seznam všech objektů blob v zadaném účtu.

.byPage() vrátí asynchronní iterátor pro výpis objektů blob na stránkách.

Příklad použití syntaxe 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říklad použití 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říklad použití 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říklad použití stránkování se značkou:

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>

Parametry

options
ContainerListBlobsOptions

Možnosti zobrazení seznamu objektů blob

Návraty

PagedAsyncIterableIterator<BlobItem, ContainerListBlobFlatSegmentResponse, PageSettings>

AsyncIterableIterator, který podporuje stránkování.

setAccessPolicy(PublicAccessType, SignedIdentifier[], ContainerSetAccessPolicyOptions)

Nastaví oprávnění pro zadaný kontejner. Oprávnění označují, jestli se k objektům blob v kontejneru může přistupovat veřejně.

Když nastavíte oprávnění pro kontejner, nahradí se stávající oprávnění. Pokud není k dispozici žádný přístup nebo seznam ContainerAcl, odebere se stávající seznam ACL kontejneru.

Když vytvoříte uložené zásady přístupu v kontejneru, může trvat až 30 sekund, než se projeví. Během tohoto intervalu sdílený přístupový podpis přidružený k uloženým zásadám přístupu selže se stavovým kódem 403 (Zakázáno), dokud zásady přístupu nebudou aktivní.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl

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

Parametry

access
PublicAccessType

Úroveň veřejného přístupu k datům v kontejneru.

containerAcl

SignedIdentifier[]

Pole prvků, které mají jedinečné ID a podrobnosti o zásadách přístupu.

options
ContainerSetAccessPolicyOptions

Možnosti operace zásad přístupu pro nastavení kontejneru

Návraty

Promise<ContainerSetAccessPolicyResponse>

setMetadata(Metadata, ContainerSetMetadataOptions)

Nastaví jeden nebo více uživatelsky definovaných párů name-value pro zadaný kontejner.

Pokud není k dispozici žádná možnost nebo v parametru nejsou definována žádná metadata, metadata kontejneru se odeberou.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata

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

Parametry

metadata
Metadata

Nahraďte stávající metadata touto hodnotou. Pokud není zadaná žádná hodnota, stávající metadata se odeberou.

options
ContainerSetMetadataOptions

Možnosti operace nastavení metadat kontejneru

Návraty

Promise<ContainerSetMetadataResponse>

uploadBlockBlob(string, RequestBodyType, number, BlockBlobUploadOptions)

Vytvoří nový objekt blob bloku nebo aktualizuje obsah existujícího objektu blob bloku.

Aktualizace existujícího objektu blob bloku přepíše všechna existující metadata objektu blob. Částečné aktualizace nejsou podporovány; obsah existujícího objektu blob se přepíše novým obsahem. Pokud chcete provést částečnou aktualizaci objektu blob bloku, použijte stageBlock a commitBlockList.

Jedná se o metodu ne paralelního nahrávání, použijte uploadFile, uploadStream nebo uploadBrowserData pro lepší výkon při nahrávání souběžnosti.

Viz https://docs.microsoft.com/rest/api/storageservices/put-blob

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

Parametry

blobName

string

Název objektu blob bloku, který se má vytvořit nebo aktualizovat

body
HttpRequestBody

Objekt blob, řetězec, ArrayBuffer, ArrayBufferView nebo funkce, která vrací nový čitelný datový proud, jehož posun je od začátku zdroje dat.

contentLength

number

Délka těla v bajtech. Pomocí Buffer.byteLength() můžete vypočítat délku textu řetězce včetně nekódovaných znaků bez kódování Base64/Hex.

options
BlockBlobUploadOptions

Možnosti konfigurace operace nahrání objektu blob bloku

Návraty

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

Objekt blob bloku nahraje data odpovědi a odpovídající instanci BlockBlobClient.