ContainerClient class

  • Referentie
Pakket:
@azure/storage-blob

Een ContainerClient vertegenwoordigt een URL naar de Azure Storage-container, zodat u de blobs kunt bewerken.

Extends

StorageClient

Constructors

ContainerClient(string, PipelineLike)

Hiermee maakt u een exemplaar van ContainerClient. Deze methode accepteert een URL die verwijst naar een container. Gecodeerde URL-tekenreeks wordt NIET tweemaal ge escaped, alleen speciale tekens in HET URL-pad worden escaped. Als een blobnaam bevat? of %, moet de blobnaam zijn gecodeerd in de URL.
ContainerClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Hiermee maakt u een exemplaar van ContainerClient. Deze methode accepteert een URL die verwijst naar een container. Gecodeerde URL-tekenreeks wordt NIET tweemaal ge escaped, alleen speciale tekens in HET URL-pad worden escaped. Als een blobnaam bevat? of %, moet de blobnaam zijn gecodeerd in de URL.
ContainerClient(string, string, StoragePipelineOptions)

Hiermee maakt u een exemplaar van ContainerClient.

Eigenschappen

containerName

De naam van de container.

Overgenomen eigenschappen

accountName
credential

Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit het @azure/identity pakket om aanvragen voor de service te verifiëren. U kunt ook een -object opgeven waarmee de TokenCredential-interface wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.
url

Gecodeerde URL-tekenreekswaarde.

Methoden

create(ContainerCreateOptions)

Hiermee maakt u een nieuwe container onder het opgegeven account. Als de container met dezelfde naam al bestaat, mislukt de bewerking.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/create-container Naamgevingsregels: Zie https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
createIfNotExists(ContainerCreateOptions)

Hiermee maakt u een nieuwe container onder het opgegeven account. Als de container met dezelfde naam al bestaat, wordt deze niet gewijzigd.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/create-container Naamgevingsregels: Zie https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
delete(ContainerDeleteMethodOptions)

Markeert de opgegeven container voor verwijdering. De container en eventuele blobs in de container worden later verwijderd tijdens de garbagecollection.

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

Markeert de opgegeven blob of momentopname voor verwijdering. De blob wordt later verwijderd tijdens de garbagecollection. Als u een blob wilt verwijderen, moet u alle momentopnamen verwijderen. U kunt beide tegelijk verwijderen met de bewerking Blob verwijderen.

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

Markeert de opgegeven container voor verwijdering als deze bestaat. De container en eventuele blobs in de container worden later verwijderd tijdens de garbagecollection.

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

Retourneert true als de Azure-containerresource die wordt vertegenwoordigd door deze client bestaat; anders onwaar.

OPMERKING: gebruik deze functie zorgvuldig omdat een bestaande container mogelijk door andere clients of toepassingen wordt verwijderd. Omgekeerd kunnen nieuwe containers met dezelfde naam worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid.
findBlobsByTags(string, ContainerFindBlobByTagsOptions)

Retourneert een asynchrone iterator om alle blobs met de opgegeven tag onder de opgegeven container te vinden.

.byPage() retourneert een asynchrone iterator om de blobs op pagina's weer te geven.

Voorbeeld met syntaxis for await :

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

Voorbeeld met 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();
}

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

Voorbeeld van paging met een markering:

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)

Alleen beschikbaar voor ContainerClient die is samengesteld met een gedeelde sleutelreferentie.

Hiermee genereert u een SAS-URI (Shared Access Signature) voor Blob Container Service op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

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

Hiermee haalt u de machtigingen voor de opgegeven container op. De machtigingen geven aan of containergegevens openbaar toegankelijk zijn.

WAARSCHUWING: JavaScript-datum verliest mogelijk de precisie wanneer het parseren begintOn- en expiresOn-tekenreeksen. Nieuwe Date("2018-12-31T03:44:23.8827891Z"). toISOString() krijgt bijvoorbeeld "2018-12-31T03:44:23.882Z".

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl
getAppendBlobClient(string)

Hiermee maakt u een AppendBlobClient
getBlobBatchClient()

Hiermee maakt u een BlobBatchClient-object om batchbewerkingen uit te voeren.

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

Hiermee maakt u een BlobClient
getBlobLeaseClient(string)

Haal een BlobLeaseClient op die leases voor de container beheert.
getBlockBlobClient(string)

Hiermee maakt u een BlockBlobClient
getPageBlobClient(string)

Hiermee maakt u een PageBlobClient
getProperties(ContainerGetPropertiesOptions)

Retourneert alle door de gebruiker gedefinieerde metagegevens en systeemeigenschappen voor de opgegeven container. De geretourneerde gegevens bevatten niet de lijst met blobs van de container.

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

WAARSCHUWING: het metadata object dat in het antwoord wordt geretourneerd, heeft de sleutels in kleine letters, zelfs als deze oorspronkelijk hoofdletters bevatten. Dit wijkt af van de metagegevenssleutels die worden geretourneerd door de listContainers methode van BlobServiceClient met behulp van de optie, waarbij de includeMetadata oorspronkelijke hoofdletters behouden blijven.
listBlobsByHierarchy(string, ContainerListBlobsOptions)

Retourneert een asynchrone iterator om alle blobs per hiërarchie weer te geven. onder het opgegeven account.

.byPage() retourneert een asynchrone iterator om de blobs per hiërarchie in pagina's weer te geven.

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

Voorbeeld met 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();
}

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

Voorbeeld van paging met een maximaal paginaformaat:

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)

Retourneert een asynchrone iterator om alle blobs onder het opgegeven account weer te geven.

.byPage() retourneert een asynchrone iterator om de blobs op pagina's weer te geven.

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

Voorbeeld met 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();
}

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

Voorbeeld van paging met een markering:

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)

Hiermee stelt u de machtigingen voor de opgegeven container in. De machtigingen geven aan of blobs in een container openbaar toegankelijk zijn.

Wanneer u machtigingen instelt voor een container, worden de bestaande machtigingen vervangen. Als er geen toegang of containerAcl is opgegeven, wordt de bestaande container-ACL verwijderd.

Wanneer u een opgeslagen toegangsbeleid instelt voor een container, kan het tot 30 seconden duren voordat het van kracht wordt. Tijdens dit interval mislukt een handtekening voor gedeelde toegang die is gekoppeld aan het opgeslagen toegangsbeleid met statuscode 403 (Verboden), totdat het toegangsbeleid actief wordt.

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

Hiermee stelt u een of meer door de gebruiker gedefinieerde naam-waardeparen in voor de opgegeven container.

Als er geen optie is opgegeven of als er geen metagegevens zijn gedefinieerd in de parameter, worden de metagegevens van de container verwijderd.

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

Hiermee maakt u een nieuwe blok-blob of werkt u de inhoud van een bestaande blok-blob bij.

Als u een bestaande blok-blob bijwerkt, worden alle bestaande metagegevens op de blob overschreven. Gedeeltelijke updates worden niet ondersteund; de inhoud van de bestaande blob wordt overschreven met de nieuwe inhoud. Als u een gedeeltelijke update van een blok-blob wilt uitvoeren, gebruikt u stageBlock en commitBlockList.

Dit is een niet-parallelle uploadmethode. Gebruik uploadFile, uploadStream of uploadBrowserData voor betere prestaties met gelijktijdig uploaden.

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

Constructordetails

ContainerClient(string, PipelineLike)

Hiermee maakt u een exemplaar van ContainerClient. Deze methode accepteert een URL die verwijst naar een container. Gecodeerde URL-tekenreeks wordt NIET tweemaal ge escaped, alleen speciale tekens in HET URL-pad worden escaped. Als een blobnaam bevat? of %, moet de blobnaam zijn gecodeerd in de URL.

new ContainerClient(url: string, pipeline: PipelineLike)

Parameters

url

string

Een URL-tekenreeks die verwijst naar Azure Storage-container, zoals 'https://myaccount.blob.core.windows.net/mycontainer". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.blob.core.windows.net/mycontainer?sasString".

pipeline
PipelineLike

Roep newPipeline() aan om een standaardpijplijn te maken of een aangepaste pijplijn op te geven.

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

Hiermee maakt u een exemplaar van ContainerClient. Deze methode accepteert een URL die verwijst naar een container. Gecodeerde URL-tekenreeks wordt NIET tweemaal ge escaped, alleen speciale tekens in HET URL-pad worden escaped. Als een blobnaam bevat? of %, moet de blobnaam zijn gecodeerd in de URL.

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

Parameters

url

string

Een URL-tekenreeks die verwijst naar Azure Storage-container, zoals 'https://myaccount.blob.core.windows.net/mycontainer". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.blob.core.windows.net/mycontainer?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit het @azure/identity pakket om aanvragen voor de service te verifiëren. U kunt ook een -object opgeven waarmee de TokenCredential-interface wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.

options
StoragePipelineOptions

Optioneel. Opties voor het configureren van de HTTP-pijplijn.

ContainerClient(string, string, StoragePipelineOptions)

Hiermee maakt u een exemplaar van ContainerClient.

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

Parameters

connectionString

string

Account connection string of een SAS-connection string van een Azure-opslagaccount. [ Opmerking: account connection string kan alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van account connection string -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.netVoorbeeld van SAS-connection string -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

Containernaam.

options
StoragePipelineOptions

Optioneel. Opties voor het configureren van de HTTP-pijplijn.

Eigenschapdetails

containerName

De naam van de container.

string containerName

Waarde van eigenschap

string

Details van overgenomen eigenschap

accountName 

accountName: string

Waarde van eigenschap

string

Overgenomen van StorageClient.accountName

credential

Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit het @azure/identity pakket om aanvragen voor de service te verifiëren. U kunt ook een -object opgeven waarmee de TokenCredential-interface wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Waarde van eigenschap

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Overgenomen van StorageClient.credential

url

Gecodeerde URL-tekenreekswaarde.

url: string

Waarde van eigenschap

string

Overgenomen van StorageClient.url

Methodedetails

create(ContainerCreateOptions)

Hiermee maakt u een nieuwe container onder het opgegeven account. Als de container met dezelfde naam al bestaat, mislukt de bewerking.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/create-container Naamgevingsregels: Zie https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

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

Parameters

options
ContainerCreateOptions

Opties voor de bewerking Container maken.

Gebruiksvoorbeeld:

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

Retouren

Promise<ContainerCreateResponse>

createIfNotExists(ContainerCreateOptions)

Hiermee maakt u een nieuwe container onder het opgegeven account. Als de container met dezelfde naam al bestaat, wordt deze niet gewijzigd.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/create-container Naamgevingsregels: Zie https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

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

Parameters

options
ContainerCreateOptions

Retouren

Promise<ContainerCreateIfNotExistsResponse>

delete(ContainerDeleteMethodOptions)

Markeert de opgegeven container voor verwijdering. De container en eventuele blobs in de container worden later verwijderd tijdens de garbagecollection.

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

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

Parameters

options
ContainerDeleteMethodOptions

Opties voor de bewerking Container verwijderen.

Retouren

Promise<ContainerDeleteResponse>

deleteBlob(string, ContainerDeleteBlobOptions)

Markeert de opgegeven blob of momentopname voor verwijdering. De blob wordt later verwijderd tijdens de garbagecollection. Als u een blob wilt verwijderen, moet u alle momentopnamen verwijderen. U kunt beide tegelijk verwijderen met de bewerking Blob verwijderen.

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

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

Parameters

blobName

string

options
ContainerDeleteBlobOptions

Opties voor de bewerking Blob verwijderen.

Retouren

Promise<BlobDeleteResponse>

Antwoordgegevens voor het verwijderen van blokblobs.

deleteIfExists(ContainerDeleteMethodOptions)

Markeert de opgegeven container voor verwijdering als deze bestaat. De container en eventuele blobs in de container worden later verwijderd tijdens de garbagecollection.

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

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

Parameters

options
ContainerDeleteMethodOptions

Opties voor de bewerking Container verwijderen.

Retouren

Promise<ContainerDeleteIfExistsResponse>

exists(ContainerExistsOptions)

Retourneert true als de Azure-containerresource die wordt vertegenwoordigd door deze client bestaat; anders onwaar.

OPMERKING: gebruik deze functie zorgvuldig omdat een bestaande container mogelijk door andere clients of toepassingen wordt verwijderd. Omgekeerd kunnen nieuwe containers met dezelfde naam worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid.

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

Parameters

options
ContainerExistsOptions

Retouren

Promise<boolean>

findBlobsByTags(string, ContainerFindBlobByTagsOptions)

Retourneert een asynchrone iterator om alle blobs met de opgegeven tag onder de opgegeven container te vinden.

.byPage() retourneert een asynchrone iterator om de blobs op pagina's weer te geven.

Voorbeeld met syntaxis for await :

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

Voorbeeld met 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();
}

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

Voorbeeld van paging met een markering:

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>

Parameters

tagFilterSqlExpression

string

Met de where-parameter kan de aanroeper query's uitvoeren op blobs waarvan de tags overeenkomen met een bepaalde expressie. De opgegeven expressie moet waar zijn om een blob te laten retourneren in de resultaten. De filtersyntaxisregel [OData - ABNF] definieert de formele grammatica voor de waarde van de parameter where-query; Er wordt echter slechts een subset van de OData-filtersyntaxis ondersteund in de Blob-service.

options
ContainerFindBlobByTagsOptions

Opties om blobs te zoeken op tags.

Retouren

PagedAsyncIterableIterator<FilterBlobItem, ContainerFindBlobsByTagsSegmentResponse, PageSettings>

generateSasUrl(ContainerGenerateSasUrlOptions)

Alleen beschikbaar voor ContainerClient die is samengesteld met een gedeelde sleutelreferentie.

Hiermee genereert u een SAS-URI (Shared Access Signature) voor Blob Container Service op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

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

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

Parameters

options
ContainerGenerateSasUrlOptions

Optionele parameters.

Retouren

Promise<string>

De SAS-URI die bestaat uit de URI naar de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

getAccessPolicy(ContainerGetAccessPolicyOptions)

Hiermee haalt u de machtigingen voor de opgegeven container op. De machtigingen geven aan of containergegevens openbaar toegankelijk zijn.

WAARSCHUWING: JavaScript-datum verliest mogelijk de precisie wanneer het parseren begintOn- en expiresOn-tekenreeksen. Nieuwe Date("2018-12-31T03:44:23.8827891Z"). toISOString() krijgt bijvoorbeeld "2018-12-31T03:44:23.882Z".

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

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

Parameters

options
ContainerGetAccessPolicyOptions

Opties voor de bewerking Toegangsbeleid voor container ophalen.

Retouren

Promise<ContainerGetAccessPolicyResponse>

getAppendBlobClient(string)

Hiermee maakt u een AppendBlobClient

function getAppendBlobClient(blobName: string): AppendBlobClient

Parameters

blobName

string

Een toevoeg-blobnaam

Retouren

AppendBlobClient

getBlobBatchClient()

Hiermee maakt u een BlobBatchClient-object om batchbewerkingen uit te voeren.

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

function getBlobBatchClient(): BlobBatchClient

Retouren

BlobBatchClient

Een nieuw BlobBatchClient-object voor deze container.

getBlobClient(string)

Hiermee maakt u een BlobClient

function getBlobClient(blobName: string): BlobClient

Parameters

blobName

string

Een blobnaam

Retouren

BlobClient

Een nieuw BlobClient-object voor de opgegeven blobnaam.

getBlobLeaseClient(string)

Haal een BlobLeaseClient op die leases voor de container beheert.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parameters

proposeLeaseId

string

Initiële voorgestelde lease-id.

Retouren

BlobLeaseClient

Een nieuw BlobLeaseClient-object voor het beheren van leases in de container.

getBlockBlobClient(string)

Hiermee maakt u een BlockBlobClient

function getBlockBlobClient(blobName: string): BlockBlobClient

Parameters

blobName

string

Een blok-blobnaam

Gebruiksvoorbeeld:

const content = "Hello world!";

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

Retouren

BlockBlobClient

getPageBlobClient(string)

Hiermee maakt u een PageBlobClient

function getPageBlobClient(blobName: string): PageBlobClient

Parameters

blobName

string

Een pagina-blobnaam

Retouren

PageBlobClient

getProperties(ContainerGetPropertiesOptions)

Retourneert alle door de gebruiker gedefinieerde metagegevens en systeemeigenschappen voor de opgegeven container. De geretourneerde gegevens bevatten niet de lijst met blobs van de container.

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

WAARSCHUWING: het metadata object dat in het antwoord wordt geretourneerd, heeft de sleutels in kleine letters, zelfs als deze oorspronkelijk hoofdletters bevatten. Dit wijkt af van de metagegevenssleutels die worden geretourneerd door de listContainers methode van BlobServiceClient met behulp van de optie, waarbij de includeMetadata oorspronkelijke hoofdletters behouden blijven.

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

Parameters

options
ContainerGetPropertiesOptions

Opties voor de bewerking Eigenschappen ophalen van container.

Retouren

Promise<ContainerGetPropertiesResponse>

listBlobsByHierarchy(string, ContainerListBlobsOptions)

Retourneert een asynchrone iterator om alle blobs per hiërarchie weer te geven. onder het opgegeven account.

.byPage() retourneert een asynchrone iterator om de blobs per hiërarchie in pagina's weer te geven.

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

Voorbeeld met 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();
}

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

Voorbeeld van paging met een maximaal paginaformaat:

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>

Parameters

delimiter

string

Het teken of de tekenreeks die wordt gebruikt om de virtuele hiërarchie te definiëren

options
ContainerListBlobsOptions

Opties voor het weergeven van blobsbewerkingen.

Retouren

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

listBlobsFlat(ContainerListBlobsOptions)

Retourneert een asynchrone iterator om alle blobs onder het opgegeven account weer te geven.

.byPage() retourneert een asynchrone iterator om de blobs op pagina's weer te geven.

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

Voorbeeld met 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();
}

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

Voorbeeld van paging met een markering:

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>

Parameters

options
ContainerListBlobsOptions

Opties voor het weergeven van blobs.

Retouren

PagedAsyncIterableIterator<BlobItem, ContainerListBlobFlatSegmentResponse, PageSettings>

Een asynchroneIterableIterator die ondersteuning biedt voor paging.

setAccessPolicy(PublicAccessType, SignedIdentifier[], ContainerSetAccessPolicyOptions)

Hiermee stelt u de machtigingen voor de opgegeven container in. De machtigingen geven aan of blobs in een container openbaar toegankelijk zijn.

Wanneer u machtigingen instelt voor een container, worden de bestaande machtigingen vervangen. Als er geen toegang of containerAcl is opgegeven, wordt de bestaande container-ACL verwijderd.

Wanneer u een opgeslagen toegangsbeleid instelt voor een container, kan het tot 30 seconden duren voordat het van kracht wordt. Tijdens dit interval mislukt een handtekening voor gedeelde toegang die is gekoppeld aan het opgeslagen toegangsbeleid met statuscode 403 (Verboden), totdat het toegangsbeleid actief wordt.

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

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

Parameters

access
PublicAccessType

Het niveau van openbare toegang tot gegevens in de container.

containerAcl

SignedIdentifier[]

Matrix van elementen met elk een unieke id en details van het toegangsbeleid.

options
ContainerSetAccessPolicyOptions

Opties voor de bewerking Toegangsbeleid voor containerset.

Retouren

Promise<ContainerSetAccessPolicyResponse>

setMetadata(Metadata, ContainerSetMetadataOptions)

Hiermee stelt u een of meer door de gebruiker gedefinieerde naam-waardeparen in voor de opgegeven container.

Als er geen optie is opgegeven of als er geen metagegevens zijn gedefinieerd in de parameter, worden de metagegevens van de container verwijderd.

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

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

Parameters

metadata
Metadata

Vervang bestaande metagegevens door deze waarde. Als er geen waarde is opgegeven, worden de bestaande metagegevens verwijderd.

options
ContainerSetMetadataOptions

Opties voor de bewerking Metagegevens van containerset.

Retouren

Promise<ContainerSetMetadataResponse>

uploadBlockBlob(string, HttpRequestBody, number, BlockBlobUploadOptions)

Hiermee maakt u een nieuwe blok-blob of werkt u de inhoud van een bestaande blok-blob bij.

Als u een bestaande blok-blob bijwerkt, worden alle bestaande metagegevens op de blob overschreven. Gedeeltelijke updates worden niet ondersteund; de inhoud van de bestaande blob wordt overschreven met de nieuwe inhoud. Als u een gedeeltelijke update van een blok-blob wilt uitvoeren, gebruikt u stageBlock en commitBlockList.

Dit is een niet-parallelle uploadmethode. Gebruik uploadFile, uploadStream of uploadBrowserData voor betere prestaties met gelijktijdig uploaden.

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

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

Parameters

blobName

string

Naam van de blok-blob die u wilt maken of bijwerken.

body
HttpRequestBody

Blob, string, ArrayBuffer, ArrayBufferView of een functie die een nieuwe leesbare stroom retourneert waarvan de offset afkomstig is van het begin van de gegevensbron.

contentLength

number

Lengte van hoofdtekst in bytes. Gebruik Buffer.byteLength() om de lengte van de hoofdtekst te berekenen voor een tekenreeks, inclusief niet-Base64-/Hex-gecodeerde tekens.

options
BlockBlobUploadOptions

Opties voor het configureren van de blok-blobuploadbewerking.

Retouren

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

Antwoordgegevens voor het uploaden van blokblobs en het bijbehorende BlockBlobClient-exemplaar.